This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

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

Created on 2021-05-19 03:27 by gregory.p.smith, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 29116 merged ethan.furman, 2021-10-21 03:15
PR 29117 merged ethan.furman, 2021-10-21 03:49
PR 29128 merged ethan.furman, 2021-10-21 18:29
Messages (8)
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.  :-)
msg404517 - (view) Author: Joseph Riddle (joeriddles) Date: 2021-10-20 18:50
_Private__names seems to no longer exist in the Python 3.11 documentation.

https://docs.python.org/3.11/library/enum.html#private-names

It appears to have been removed in this PR https://github.com/python/cpython/pull/23748/files

Should this issue be updated to remove Python 3.11 from the Versions?
msg404524 - (view) Author: Ethan Furman (ethan.furman) * (Python committer) Date: 2021-10-20 20:13
It has been moved to the tutorial (links are at the top of the Enum page).
msg404565 - (view) Author: Ethan Furman (ethan.furman) * (Python committer) Date: 2021-10-21 03:32
New changeset 7c4d96103c4e16161e9aed9a584c9857d0674099 by Ethan Furman in branch 'main':
bpo-44174: [Enum] add reference to name mangling (GH-29116)
https://github.com/python/cpython/commit/7c4d96103c4e16161e9aed9a584c9857d0674099
msg404618 - (view) Author: Ethan Furman (ethan.furman) * (Python committer) Date: 2021-10-21 16:50
New changeset 828722aca4ccba893f6b2e8c1d41fd74fd6e208d by Ethan Furman in branch '3.10':
[3.10] bpo-44174: [Enum] add reference to name mangling (GH-29117)
https://github.com/python/cpython/commit/828722aca4ccba893f6b2e8c1d41fd74fd6e208d
msg404633 - (view) Author: Ethan Furman (ethan.furman) * (Python committer) Date: 2021-10-21 18:32
New changeset e628700dbf2c3376502cbb5a9bff2d58d1102e16 by Ethan Furman in branch '3.9':
[3.9] bpo-44174: [Enum] add name-mangling reference (GH-29128)
https://github.com/python/cpython/commit/e628700dbf2c3376502cbb5a9bff2d58d1102e16
History
Date User Action Args
2022-04-11 14:59:45adminsetgithub: 88340
2021-10-21 18:33:16ethan.furmansetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2021-10-21 18:32:32ethan.furmansetmessages: + msg404633
2021-10-21 18:29:38ethan.furmansetpull_requests: + pull_request27404
2021-10-21 16:50:41ethan.furmansetmessages: + msg404618
2021-10-21 03:49:37ethan.furmansetpull_requests: + pull_request27393
2021-10-21 03:32:18ethan.furmansetmessages: + msg404565
2021-10-21 03:15:25ethan.furmansetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request27392
2021-10-20 20:13:09ethan.furmansetmessages: + msg404524
2021-10-20 18:50:12joeriddlessetnosy: + joeriddles
messages: + msg404517
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