aeon
aeon copied to clipboard
[DOC] Add Raises section for invalid `weights` in KNeighborsTimeSeriesClassifier (#1766)
Reference Issues/PRs
Addresses part of #1766.
What does this implement/fix? Explain your changes.
Adds the "Raises" section to the __init__ docstring of KNeighborsTimeSeriesClassifier.
Documents the verified ValueError raised during initialization when an unsupported string or an invalid callable is provided to the weights parameter.
This update improves user guidance by clarifying expected exceptions and aligns with Aeon's documentation standards.
Does your contribution introduce a new dependency? If yes, which one?
No new dependencies introduced.
Any other comments?
This contribution is part of my preparation and engagement for GSoC 2025, aligned with Aeon's project list.
I am grateful for any feedback to improve this PR and my future contributions.
PR checklist
- [x] The PR title starts with [DOC] as per contribution guidelines.
- [x] The change improves documentation clarity without introducing code changes.
- [x] No new dependencies added.
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-commitchecks for all files - [ ] Run
mypytypecheck tests - [ ] Run all
pytesttests and configurations - [ ] Run all notebook example tests
- [ ] Run numba-disabled
codecovtests - [ ] Stop automatic
pre-commitfixes (always disabled for drafts) - [ ] Disable numba cache loading
- [ ] Push an empty commit to re-run CI checks