aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[DOC] A fix to inconsistent double tick quote for the classification.distance_based module

Open Ahmed-Zahran02 opened this issue 8 months ago • 5 comments

Reference Issues/PRs

Fixes #809

What does this implement/fix? Explain your changes.

This PR fixes the inconsistent use of double tick quotes in docstring https://github.com/aeon-toolkit/aeon/issues/809 In the Classification.distance_based module i fixed all the misusage of tick quotes. for example:

n_jobs : int, default=1
      The number of jobs to run in parallel for both ``fit`` and ``predict``.
      `-1` means using all processors.

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

No

Any other comments?

None

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.
For new estimators and functions
  • [ ] (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
  • [ ] I've added the estimator/function to the online API documentation.
For developers with write access
  • [ ] (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

Ahmed-Zahran02 avatar Mar 16 '25 09:03 Ahmed-Zahran02

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 16 '25 09:03 aeon-actions-bot[bot]

This seems incomplete? There are still cases with single ` usage. Some new ones were added by the look of things.

MatthewMiddlehurst avatar Apr 03 '25 14:04 MatthewMiddlehurst

@MatthewMiddlehurst
Ok, I made some changes in another commit. You can check them.

Ahmed-Zahran02 avatar Apr 04 '25 19:04 Ahmed-Zahran02

I dont see a new commit other than a merge with main?

MatthewMiddlehurst avatar Apr 04 '25 22:04 MatthewMiddlehurst

@MatthewMiddlehurst sorry, i tried to fix it. you can check them

Ahmed-Zahran02 avatar Apr 05 '25 00:04 Ahmed-Zahran02

hi, thanks for this @Ahmed-Zahran02 , could you resolve the conflict? Seems to be a minor thing in the docstring

TonyBagnall avatar May 18 '25 10:05 TonyBagnall

@all-contributors add @Ahmed-Zahran02 for docs

MatthewMiddlehurst avatar Jun 09 '25 17:06 MatthewMiddlehurst

@MatthewMiddlehurst

I've put up a pull request to add @Ahmed-Zahran02! :tada:

allcontributors[bot] avatar Jun 09 '25 17:06 allcontributors[bot]