Skip to content

Type hinting developer docs #26051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 1, 2023
Merged

Type hinting developer docs #26051

merged 4 commits into from
Aug 1, 2023

Conversation

ksunden
Copy link
Member

@ksunden ksunden commented Jun 2, 2023

PR summary

  • Update devdocs with more details about type hinting, especially deprecations
  • Bring existing parameter keyword only deprecations in line with documentation
    • Deprecated and slated for removal deprecations are not added, though going forward we suggest not removing the hints where they already exist until expiry.

I considered adding something regarding the behavior of the alias decorator (namely that the aliases are not type hinted, added to the mypy-stubtest-allowlist.txt file)
But there was not already a section about that decorator, and it is rare enough that it gets added that I don't necessarily think its warrented to write one just for this.

PR checklist

@timhoffm timhoffm merged commit 791347b into matplotlib:main Aug 1, 2023
@ksunden ksunden added this to the v3.8.0 milestone Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants