[DOC] Created a adding_typehints.md in developers_guide that Fixes issue #1857

[vedpawar2254]

Added a documentation file about adding type hints

Reference Issues/PRs

Fixes #1857

What does this implement/fix? Explain your changes.

This adds a file to the developers_guide and the file contains a guide to adding type hints in the project

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

[aeon-actions-bot]

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].

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

[vedpawar2254]

@all-contributors please add @vedpawar2254 for Documentation

[allcontributors]

@vedpawar2254

I've put up a pull request to add @vedpawar2254! 🎉

[baraline]

Hi! Thanks for the PR, I'm wondering if that kind of content shouldn't be added as a section in the coding standard page rather than on its own.
@MatthewMiddlehurst do we consider type hint as a standard or simply a good practice?

[MatthewMiddlehurst]

Hi! Thanks for the PR, I'm wondering if that kind of content shouldn't be added as a section in the coding standard page rather than on its own. @MatthewMiddlehurst do we consider type hint as a standard or simply a good practice?

I think see where this ends up then decide

[krushndayshmookh]

I think this should be enforced as a standard to ensure consistent typing as tooling support is important to ensure code quality.