Add 'annotations' to the glossary

[csabella]

BPO	32769
Nosy	@gvanrossum, @bitdancer, @ambv, @matrixise, @ilevkivskyi, @csabella, @andresdelfino
PRs	bpo-32769: Write annotation entry for glossary #6657 [3.7] bpo-32769: Write annotation entry for glossary (GH-6657) #6821 bpo-32769: A new take on annotations/type hinting glossary entries #6829 [3.7] bpo-32769: A new take on annotations/type hinting glossary entries (GH-6829) #7127 [3.6] bpo-32769: A new take on annotations/type hinting glossary entries (GH-6829) #7128 bpo-32769: Fix typo spotted by Guido in Annotation glossary entry #7131

^{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

GitHub fields:

assignee = None
closed_at = <Date 2018-07-28.13:04:20.536>
created_at = <Date 2018-02-04.23:13:13.525>
labels = ['easy', '3.8', 'type-feature', '3.7', 'docs']
title = "Add 'annotations' to the glossary"
updated_at = <Date 2018-07-28.13:04:20.535>
user = 'https://github.com/csabella'

bugs.python.org fields:

activity = <Date 2018-07-28.13:04:20.535>
actor = 'steve.dower'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-07-28.13:04:20.536>
closer = 'steve.dower'
components = ['Documentation']
creation = <Date 2018-02-04.23:13:13.525>
creator = 'cheryl.sabella'
dependencies = []
files = []
hgrepos = []
issue_num = 32769
keywords = ['patch', 'easy']
message_count = 31.0
messages = ['311796', '311900', '311904', '311905', '311907', '315953', '316121', '316143', '316146', '316147', '316553', '316557', '316558', '316559', '316562', '316564', '316566', '316568', '316618', '316646', '316648', '316650', '316674', '316705', '316714', '316739', '316751', '316752', '317741', '317746', '317749']
nosy_count = 8.0
nosy_names = ['gvanrossum', 'r.david.murray', 'docs@python', 'lukasz.langa', 'matrixise', 'levkivskyi', 'cheryl.sabella', 'adelfino']
pr_nums = ['6657', '6821', '6829', '7127', '7128', '7131']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32769'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']

[matrixise]

There is a description of the annotation in the Glossary, but with 'function annotation'

maybe we could rename 'function annotation' by 'annotation'

[ilevkivskyi]

This is a rather small change, so probably it would be easier to discuss it in a PR.

[bitdancer]

PRs are for discussing proposed text/code. Discussion of whether or not to do this belongs here. (I have no opinion on this issue myself.)

[ilevkivskyi]

I wanted to say implicitly that I like the idea, and that we should figure out details in a PR. But of course if someone is against this, then we should wait with a PR.

[gvanrossum]

I'm all for adding a bunch of terms related to type hints/annotations to the Glossary.

[andresdelfino]

I just made a PR to start working on the right wording.

[andresdelfino]

Guido, now that we are working on this, perhaps you can list what other terms related to type hints/annotations you were thinking for addition.

[gvanrossum]

Perhaps you can start with the more important terms from PEP-484 (and
perhaps also PEP-483, and then PEP-526 and PEP-544). E.g. start with terms
from the ToC of those PEPs.

[andresdelfino]

Great, I'll look into them.

It will take me some time to make a list of the new terms and write proper descriptions. Perhaps we could deliver the updates to the glossary by waves so people can make benefit of it? As in multiple PR being merged while retaining this issue open until all required terms are added.

[gvanrossum]

I'm okay with multiple PRs, but do beware that each PR requires a core dev
to open a browser window etc., so try to group them a bit. But no need to
wait for the perfect list!