[DOC] Update the docstring for BaseSegmenter

TonyBagnall commented 3 months ago

Updates doc string which was still from the development stage, and incorrect in places

review-notebook-app[bot] commented 3 months ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

aeon-actions-bot[bot] commented 3 months ago

Thank you for contributing to `aeon`

I would have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$, $\color{#0e8a16}{\textsf{segmentation}}$ ], however some package labels are already present.

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 all pytest tests and configurations
[ ] Run all notebook example tests
[ ] Run numba-disabled codecov tests
[ ] Stop automatic pre-commit fixes (always disabled for drafts)

aeon-toolkit / aeon