aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[DOC] Fix inconsistent double back ticks for the transformations module #809

Open Omabekee opened this issue 8 months ago • 3 comments

Reference Issues/PRs

Fixes #809

What does this implement/fix? Explain your changes.

This pull request resolves #809 by fixing the inconsistent use of double backticks (``) in docstrings across all modules in the Transformations notebook.

Does your contribution introduce a new dependency? If yes, which one?

No, this PR does not introduce any new dependencies.

Any other comments?

Let me know if any more changes are needed, happy to update as per the maintainers' guidelines

PR checklist

For all contributions
  • [ ] I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • [x] The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.

Omabekee avatar Mar 31 '25 01:03 Omabekee

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ]. I have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$ ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • [ ] Run pre-commit checks for all files
  • [ ] Run mypy typecheck tests
  • [ ] Run all pytest tests and configurations
  • [ ] Run all notebook example tests
  • [ ] Run numba-disabled codecov tests
  • [ ] Stop automatic pre-commit fixes (always disabled for drafts)
  • [ ] Disable numba cache loading
  • [ ] Push an empty commit to re-run CI checks

aeon-actions-bot[bot] avatar Mar 31 '25 01:03 aeon-actions-bot[bot]

Please avoid closing and creating PRs for the same issue if possible.

The issue linked is for docstrings, not examples. Either way, dont close it in the text as it does not resolve the full issue.

Please loot at the output in the notebooks you have changed as a lot of this does not look correct. `` is the RST style for code, single ` works in markdown which is how examples are rendered.

MatthewMiddlehurst avatar Apr 03 '25 09:04 MatthewMiddlehurst

Some of the changes are good like the pycatch22 ones, but a lot is unnecessary looking at the webpage rendering.

Feel free to re-open if you wish to continue.

MatthewMiddlehurst avatar May 08 '25 13:05 MatthewMiddlehurst