Clarify documentation regarding unequal length series limitation

[Kaustbh]

Reference Issues/PRs

Fixes: #2444

What does this implement/fix? Explain your changes.

This PR updates the documentation to clarify the supported input data formats for the collection transformers module

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

Any other comments?

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{#41A8F6}{\textsf{transformations}}$ ]. 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]

My bad, see latest issue comment.

[MatthewMiddlehurst]

The first PR was more accurate, but we do not need a large warning IMO. Perhaps just tidy the first paragraph and change the part about np-list to reflect that it does not have to be unequal length (but that is its primary usage). The capabilities paragraph below that is sufficient but if you think it can be improved go ahead.

[Kaustbh]

@MatthewMiddlehurst I have made the changes please review and let me know if any changes are needed.

[MatthewMiddlehurst]

The capabilities part is repetitive IMO. The problem part is (any number of channels, unequal length series), removing that is probably enough TBH. If you think it can be improved further feel free to make suggestions, but we do not want to bloat it.

[Kaustbh]

kept (number of channels, series length) to indicate the shape of NumPy array inside the list.

[MatthewMiddlehurst]

Please try to avoid force pushing like this if you can.

[MatthewMiddlehurst]

or give us a hand in finding out why doing so breaks pre-commit testing i guess 🙂

[Kaustbh]

Please try to avoid force pushing like this if you can.

Apologies! I usually force push to keep a single commit in a PR that contains all the changes made so far. Is this not a recommended approach? What would you suggest as a best practice in the open-source world 😊?

[MatthewMiddlehurst]

Beside breaking our CI, having a change log of commits is helpful for reviewing. Please just merge or rebase in the future. These are all squished on merge into a single commit either way.