classification
Title: Unclear meaning of _Private__names in enum docs.
Type: Stage: needs patch
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ethan.furman, gregory.p.smith, kj
Priority: normal Keywords: easy, newcomer friendly

Created on 2021-05-19 03:27 by gregory.p.smith, last changed 2021-05-19 17:13 by ethan.furman.

Messages (3)
msg393919 - (view) Author: Gregory P. Smith (gregory.p.smith) * (Python committer) Date: 2021-05-19 03:27
https://docs.python.org/3/library/enum.html#private-names

"""
_Private__names

Private names will be normal attributes in Python 3.10 instead of either an error or a member (depending on if the name ends with an underscore). Using these names in 3.9 will issue a DeprecationWarning.
"""

It isn't clear from this documentation what is meant by "private names".  Please expand on this to be explicit about what name pattern is being described.
msg393939 - (view) Author: Ken Jin (kj) * (Python committer) Date: 2021-05-19 09:17
I think linking to this part of the docs may help https://docs.python.org/3/reference/expressions.html#atom-identifiers

There's also already a label to reference to, so
the sentence could start with :ref:`Private names <private-name-mangling>`.
msg393960 - (view) Author: Ethan Furman (ethan.furman) * (Python committer) Date: 2021-05-19 17:13
Looks good.  Patches welcome.  :-)
History
Date User Action Args
2021-05-19 17:13:52ethan.furmansetnosy: + ethan.furman
messages: + msg393960
2021-05-19 09:17:32kjsetkeywords: + easy, newcomer friendly
nosy: + kj
messages: + msg393939

2021-05-19 03:27:49gregory.p.smithcreate