New submission from Larry Hastings <la...@hastings.org>:

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.

----------
assignee: larry
components: Documentation
messages: 392419
nosy: larry
priority: normal
severity: normal
stage: needs patch
status: open
title: Add "Annotations Best Practices" to HOWTO
type: enhancement
versions: Python 3.10

_______________________________________
Python tracker <rep...@bugs.python.org>
<https://bugs.python.org/issue43987>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to