Author lukasz.langa
Recipients adelfino, cheryl.sabella, docs@python, gvanrossum, levkivskyi, lukasz.langa, matrixise, r.david.murray
Date 2018-05-15.19:30:03
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1526412603.81.0.682650639539.issue32769@psf.upfronthosting.co.za>
In-reply-to
Content
> It may be deprecated but the usage still exists. This is a glossary, not a manifesto.

Agreed.  However, based on the current wording users will argue that Python documentation itself is stressing the lack of an intended purpose for annotations, equaling the typing use case with all other use cases (including future ones).  This isn't our intent.

I think it would be clearer to change the current wording from:

> A metadata value associated with a variable, a class attribute or a
> function or method parameter or return value, that has no specific
> purpouse (i.e. it's up to the user to use it as they see fit).
> (...)
> Annotations can be used to specify :term:`type hints <type hint>`.

to:

> A metadata value associated with a variable, a class attribute or a
> function or method parameter or return value, that stores a
> :term:`type hint`.
> (...)
> Annotations can be used for other purposes unrelated to typing. This
> usage is deprecated, see :pep:`563` for details.


The `type hint` phrasing is already there, we just need to delete the word "global" that currently appears before "variable".  Note that saying that annotations in class attributes and variables have no assigned meaning contradicts PEP 526.
History
Date User Action Args
2018-05-15 19:30:03lukasz.langasetrecipients: + lukasz.langa, gvanrossum, r.david.murray, docs@python, matrixise, levkivskyi, cheryl.sabella, adelfino
2018-05-15 19:30:03lukasz.langasetmessageid: <1526412603.81.0.682650639539.issue32769@psf.upfronthosting.co.za>
2018-05-15 19:30:03lukasz.langalinkissue32769 messages
2018-05-15 19:30:03lukasz.langacreate