aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[DOC] Fix double back tick inconsistencies in classification module docstrings

Open ISHOOO opened this issue 8 months ago • 2 comments

Reference Issues/PRs

Fixes #809

What does this implement/fix? Explain your changes.

This pull request fixes backtick inconsistencies in all docstrings of all classes in the classification module.
The preferred approach mentioned by the maintainers was to use double backticks (). So, I replaced all single quotes (') with double backticks () throughout the classification module.

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

No, this PR does not introduce any new dependencies.

Any other comments?

This is a documentation-only change, so no functional code modifications were made.

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 after the PR has been merged.
  • [x] The PR title starts with [DOC] indicating that this is a documentation-related change.

ISHOOO avatar Mar 27 '25 09:03 ISHOOO

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{#BCAE15}{\textsf{classification}}$ ]. 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 27 '25 09:03 aeon-actions-bot[bot]

Greetings @MatthewMiddlehurst, thanks for taking time to review my pull request. I've read all the remarks and will make sure to keep them in mind for all my future contributions to aeon. Also the typo error 'lcoefficients' has been fixed to 'coefficients' along with a few others. I have made the commit to my branch and I suppose the current PR should get updated soon regarding this commit.

ISHOOO avatar Apr 05 '25 19:04 ISHOOO