You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
assignee='https://github.com/larryhastings'closed_at=<Date2021-05-02.08:22:39.990>created_at=<Date2021-04-30.11:26:13.887>labels= ['type-feature', '3.10', 'docs']
title='Add "Annotations Best Practices" to HOWTO'updated_at=<Date2021-05-02.08:22:39.990>user='https://github.com/larryhastings'
Dealing with annotations is complicated. I think there should be a section of the Python documentation describing best practices for working
with annotations. So, here goes.
The best spot I found for it was as a new HOWTO. I added links to that HOWTO to a couple relevant glossary definitions, and one in the documentation for inspect.get_annotations(). I'm not sure if it makes sense to add any other links; I considered adding links to the HOWTO to where the __annotations__ attribute is defined on functions, modules, and classes, in reference/datamodel.rst, but it just didn't seem like a good idea.