[DOC] Add Raises to docstrings for methods that can raise exceptions

[TonyBagnall]

Describe the issue linked to the documentation

We mostly do not document the errors raised and the reasons for them. It would be good to do so. This should be done incrementally and is a good first issue.

1. Pick and estimator and try break it
2. Look at the docstrings (may be base class) and see if its documented
3. If not add under

Raises

we may need to discuss where it should be documented and the effect this has on the documentation @MatthewMiddlehurst. I'll look for a good example

Suggest a potential alternative/fix

No response

[aryanpola]

Hello, I am new to open-source contributions and am trying to learn how things work. Can you please point me to any resources that would be useful to solve the issue.

[MatthewMiddlehurst]

I would start by reading our contributor guide and joining the Slack channel https://www.aeon-toolkit.org/en/stable/contributing.html.

Best way to find these is probably searching what raises errors to start with. A good first estimator for this may be cBOSS? https://github.com/aeon-toolkit/aeon/blob/main/aeon/classification/dictionary_based/_cboss.py#L210

As the main issue states, we will have to discuss where best to document these though, as out _fit/_predict framework does not allow for changing the docstring of fit and predict.

[aryanpola]

@MatthewMiddlehurst , will describing the error raised be enough, or do we add some information regarding the parameters causing the error, and also where do we add the documented file? I've described the type of error, the parameters causing the error, and the suggested action.