From: R David Murray <rdmurray@bitdance.com>
Date: Mon, 6 May 2013 16:58:16 +0000 (-0400)
Subject: #14187: Add glossary entry for 'function annotations'.
X-Git-Tag: v3.3.2~25
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=25cd09115d221a9befb3cb57e2226444448d60d1;p=thirdparty%2FPython%2Fcpython.git

#14187: Add glossary entry for 'function annotations'.

Patch by Chris Rebert.
---

diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index f30138adbc10..63f1021afcbb 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.