[DOC] Created adding_type_hints.md ; issue solved:aeon-toolkit#1857

[vedpawar2254]

No description provided.

[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.

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 follow the contributing guide and PR template guidance, just deleting the template does not give off a good impression.

You can view the webpage output here: https://aeon-toolkit--2421.org.readthedocs.build/en/2421/developer_guide/adding_type_hints.html.
There is not currently a link to this on the website anywhere, i can help with this if you need.

IMO there is too much here currently, we don't really need this much. At most a few basic examples and a link to other guidance are needed i.e. one each for a function and class with different parameter types, no large docstrings needed.

The motivation and benefits sections are unnecessary as well as best practices and conclusion IMO. The PyODAdapter example is a bit insufficient currently with just imports, I would not call it a case study.

Feel free to ask any questions if this is confusing.

[vedpawar2254]

@MatthewMiddlehurst I am sorry i messed up the PR template accidentally and i will also remove the unnecessary, i actually didn't plan to add them but saw something similar in other docs so i thought it was a good practice to add something like that, ill fix it asap