[issue14187] add "annotation" entry to Glossary

Chris Rebert added the comment: Here's an actual patch. -- keywords: +patch Added file: http://bugs.python.org/file25544/func_annotation.patch ___ Python tracker ___ ___

[issue14187] add "annotation" entry to Glossary

Éric Araujo added the comment: Looks good to me, with the proviso that it should be “function annotation”. -- versions: +Python 3.2 ___ Python tracker ___ __

[issue14187] add "annotation" entry to Glossary

Chris Rebert added the comment: Any reactions to the strawman wording for the entry? -- ___ Python tracker ___ ___ Python-bugs-list m

[issue14187] add "annotation" entry to Glossary

Chris Rebert added the comment: Strawman entry wording: An annotation is an arbitrary metadata value associated with a function parameter or return value. The syntax for function annotations is explained in [Function definitions][http://docs.python.org/dev/reference/compound_stmts.html#funct

[issue14187] add "annotation" entry to Glossary

Raymond Hettinger added the comment: Propose some brief text for an entry so we have something to evaluate for its utility. -- assignee: docs@python -> rhettinger ___ Python tracker __

[issue14187] add "annotation" entry to Glossary

Chris Rebert added the comment: Also, it would be a nice place to point out for those coming from Java or similar that the Java-esque concept of annotations has little to do with Python's function annotations, and that in Python their uses are typically served using decorators instead. -

[issue14187] add "annotation" entry to Glossary

Ezio Melotti added the comment: FWIW searching for "annotations" in the Sphinx quick search doesn't yield anything interesting, and the first result that actually contains a paragraph about annotations is the 11th (compound statements). -- ___ Pyth

[issue14187] add "annotation" entry to Glossary

Chris Rebert added the comment: Well, I thought the Glossary was a somewhat useful document in and of itself ("What's conceptual term 'X' mean? Hmm... I'll check the Glossary!") and so should include all terms which aren't module-specific. But I won't push hard if no one else sees value in ad

[issue14187] add "annotation" entry to Glossary

Éric Araujo added the comment: I think too that function annotations don’t need to be in the glossary; documenting them in the language reference section that talks about defining functions should be enough. What do you think, Chris? -- nosy: +eric.araujo ___

[issue14187] add "annotation" entry to Glossary

Changes by Ezio Melotti : -- nosy: +ezio.melotti type: -> enhancement ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubs

[issue14187] add "annotation" entry to Glossary

Raymond Hettinger added the comment: I'm not sure this would be a worthwhile addition. This language feature is not widely referenced outside the docs for the feature itself. -- nosy: +rhettinger ___ Python tracker

[issue14187] add "annotation" entry to Glossary

New submission from Chris Rebert : The Glossary should include an entry for "annotation" and/or "function annotation" regarding the language feature introduced by PEP 3107. -- assignee: docs@python components: Documentation messages: 154852 nosy: cvrebert, docs@python priority: normal s