[DOC] Inconsistent double ticks in segmentation package, public docstring only

[nMaax]

Reference Issues/PRs

#809

What does this implement/fix? Explain your changes.

Updated docstring of segmentation package using double back ticks as requested in #809

I purposely did not update methods' docstring of those same public classes that were preceded by an underscore (_) assuming them to be only for internal use. - e.g. I did update HMMSegmenter class docstring, but not its method _get_test_params() as it is preceded by an underscore. I adopted this more conservative approach since it is easier to add new eventual commits in case admins of this repo change their mind about how to deal with this minor detail.

By the way, assuming my approach as standard rule, during the docstring review I found some violation of this as some previous contributors used double backticks also for such private methods of public classes - e.g. _get_neighbourhood_params docstring in _hidalgo.py at line 145-147 was written as

mu : np.ndarray
    1D np.ndarray of length m. parameter in Pereto distribtion estimated by
    ``r2/r1`` <---- (HERE)

I left also this untouched as it is still not clear whether such use of back ticks should be updated or not (anyway, as far as I remember, the example reported is the only case where such case happened in the segmentation package).

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

None

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

• [ ] I've added the estimator/function to the online API documentation.
• [ ] (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.

For developers with write access

• [ ] (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

[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{#0e8a16}{\textsf{segmentation}}$ ]. 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