Skip to content

gh-92120: The docstring of enum.Enum is invalid in reST #92122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 8, 2022
Merged

gh-92120: The docstring of enum.Enum is invalid in reST #92122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d95098e
gh-92120: The docstring of enum.Enum is invalid in reST
tk0miya May 1, 2022
61c60b9
Merge branch 'main' into gh-92120/invalid_docstring_of_Enum
ethanfurman Dec 7, 2022
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Lib/enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,20 +1054,20 @@ class Enum(metaclass=EnumType):

Access them by:

- attribute access::
- attribute access:

>>> Color.RED
<Color.RED: 1>
>>> Color.RED
<Color.RED: 1>

- value lookup:

>>> Color(1)
<Color.RED: 1>
>>> Color(1)
<Color.RED: 1>

- name lookup:

>>> Color['RED']
<Color.RED: 1>
>>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2022-05-06-01-53-34.gh-issue-92122.96Lf2p.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix reStructuredText syntax errors in docstrings in the :mod:`enum` module.