[DOC] Add 'Raises' section to docstring (#1766)

[Nikitas100]

Reference Issues/PRs

See #1766.

What does this implement/fix? Explain your changes.

This PR adds a "Raises" section to the docstring of the ContractableBOSS class to document the ValueError exception. It also fixes line endings. Testing: I’ve updated relevant tests to ensure that the ValueError exception is correctly handled.

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

No

Any other comments?

This PR improves code documentation and ensures consistent line endings for cross-platform compatibility.

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

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
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

[MatthewMiddlehurst]

Please fill out the template instead of leaving it blank, and title the PR appropriately. See the contributor guide on our website.

A lot of the changes seem unnecessary. Raises should only contain known exceptions/errors being intentionally raised in the code, not any possible unintended error. There is already a check for the window sizes, not sure why we need another.

[Nikitas100]

Hey @MatthewMiddlehurst, thank you for your feedback. I've filled out the template and updated the title of the PR as suggested.

Regarding the Raises section, I noticed that the check if self.min_window > max_window + 1 is already implemented to validate the window sizes. Could you clarify if you see this as redundant or if there's a different approach you would recommend for validating the window sizes? I'm happy to make adjustments based on your suggestions

[MatthewMiddlehurst]

Updated text so the PR does not close the issue.

I would say the new attribute and functions are redundant given that it is already checked in fit. The raises in private/protected functions are also unnecessary.

[Nikitas100]

Hi @MatthewMiddlehurst and @TonyBagnall, I’ve made the requested changes. Please review it and let me know if there’s anything else.

[MatthewMiddlehurst]

The PR contains a lot of unnecessary whitespace additions and some of the documentation has been duplicated for some reason. Please resolve.

[MatthewMiddlehurst]

LGTM, thanks.