[DOC] resolved the inconsistency of double ticks for the anomaly detection module #809

[AnaghDeshpande]

Reference Issues/PRs

#809

What does this implement/fix? Explain your changes.

This PR addresses the issue Inconsistent double tick quotes in docstrings #809.

In the anomaly_detection module i have changed all the double tick quotes to single tick quotes.

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

Any other comments?

PR checklist

For all contributions

• [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.

[aeon-actions-bot[bot]]

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{#6F6E8D}{\textsf{anomaly detection}}$ ]. 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

[SebastianSchmidl]

Did I get the issue wrong, or is this PR transforming the quotes the wrong way around?

Single ticks render as italics while double ticks render as code in the api docs, e.g. int v.s. int.

I think double ticks is preferable

IMO, code references, such as class names, parameter names, and default values should, thus, be in double quotes: ``

[AnaghDeshpande]

Sorry for the mistake i will change it to double quotes.

[MatthewMiddlehurst]

Thanks Sebastian for the review. Please check how changes are rendered after you make them in the PR docs build https://aeon-toolkit--2546.org.readthedocs.build/en/2546/

[MatthewMiddlehurst]

Hi, is this still active @AnaghDeshpande?

[AnaghDeshpande]

@MatthewMiddlehurst yes sir. will update the changes.

[MatthewMiddlehurst]

@all-contributors add @AnaghDeshpande for docs

[allcontributors[bot]]

@MatthewMiddlehurst

I've put up a pull request to add @AnaghDeshpande! :tada: