summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-05-06 16:58:16 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-05-06 16:58:16 (GMT)
commit25cd09115d221a9befb3cb57e2226444448d60d1 (patch)
tree2fb9aad88ea69e88dee57e384b4dece096144bc9 /Doc
parentdef51ca8ea68630f4e3d3a1d8b9b5a4aceb91105 (diff)
downloadcpython-25cd09115d221a9befb3cb57e2226444448d60d1.zip
cpython-25cd09115d221a9befb3cb57e2226444448d60d1.tar.gz
cpython-25cd09115d221a9befb3cb57e2226444448d60d1.tar.bz2
#14187: Add glossary entry for 'function annotations'.
Patch by Chris Rebert.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/glossary.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index f30138a..63f1021 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -252,6 +252,16 @@ Glossary
the execution of the body. See also :term:`parameter`, :term:`method`,
and the :ref:`function` section.
+ function annotation
+ An arbitrary metadata value associated with a function parameter or return
+ value. Its syntax is explained in section :ref:`function`. Annotations
+ may be accessed via the :attr:`__annotations__` special attribute of a
+ function object.
+
+ Python itself does not assign any particular meaning to function
+ annotations. They are intended to be interpreted by third-party libraries
+ or tools. See :pep:`3107`, which describes some of their potential uses.
+
__future__
A pseudo-module which programmers can use to enable new language features
which are not compatible with the current interpreter.