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

Merged

ethanfurman merged 2 commits intopython:mainfrom

tk0miya:gh-92120/invalid_docstring_of_Enum

Dec 8, 2022

Merged

gh-92120: The docstring of enum.Enum is invalid in reST#92122
ethanfurman merged 2 commits intopython:mainfrom
tk0miya:gh-92120/invalid_docstring_of_Enum

Conversation

Copy link

Contributor

tk0miya commentedMay 1, 2022•
edited by bedevere-bot
Loading

Closes#92120

Issue:The docstring ofenum.Enum is invalid in reStructuredText since 3.11 #92120

tk0miya requested a review fromethanfurman as acode owner

May 1, 2022 17:42

bedevere-bot added the awaiting review label

May 1, 2022

AlexWaygood added stdlib

Standard Library Python modules in the Lib/ directory

type-bugAn unexpected behavior, bug, or error labels

May 1, 2022

Copy link

Member

hugovk commentedMay 1, 2022

Thank you Takeshi-san!

Are similar fixes needed in theEnumType class?

cpython/Lib/enum.py

Line 504 inad5e852

- attribute access::

cpython/Lib/enum.py

Line 558 inad5e852

- attribute access::

Please could you include a NEWS file?

https://devguide.python.org/committing/#updating-news-and-what-s-new-in-python

Copy link

Member

ethanfurman commentedMay 1, 2022

I am more interested in the docstrings being usable bydoctest than being correct reStructured text. Have you verified thatdoctest correctly executes the docstrings with your changes applied?

tk0miya force-pushed thegh-92120/invalid_docstring_of_Enum branch 4 times, most recently from4b243fd toeb44f0bCompare

May 5, 2022 18:01

Copy link

ContributorAuthor

tk0miya commentedMay 5, 2022

Thank you for your reviews! I also fixed EnumTypes class.

Have you verified that doctest correctly executes the docstrings with your changes applied?

Yes. I confirmed it on my local. This change does not prevent the result of doctest. Of course, the number of cases are not changed. Additionally, doctest on GitHub Action is also passed.
refs:https://github.com/python/cpython/runs/6310616547?check_suite_focus=true_