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

Jump to bottom
Merged
merged 2 commits into from
Dec 8, 2022
Merged

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

merged 2 commits into from
Dec 8, 2022

Conversation

tk0miya
Copy link
Contributor

@tk0miya tk0miya commented May 1, 2022 •
edited by bedevere-bot
Loading

@tk0miya tk0miya requested a review from ethanfurman as a code owner May 1, 2022 17:42
@AlexWaygood AlexWaygood added stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error labels May 1, 2022
@hugovk
Copy link
Member

hugovk commented May 1, 2022

Thank you Takeshi-san!

Are similar fixes needed in the EnumType class?

cpython/Lib/enum.py

Line 504 in ad5e852

- attribute access::

cpython/Lib/enum.py

Line 558 in ad5e852

- attribute access::

Please could you include a NEWS file?

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

@ethanfurman
Copy link
Member

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

@tk0miya tk0miya force-pushed the gh-92120/invalid_docstring_of_Enum branch 4 times, most recently from 4b243fd to eb44f0b Compare May 5, 2022 18:01
@tk0miya
Copy link
Contributor Author

tk0miya commented May 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_

@tk0miya tk0miya force-pushed the gh-92120/invalid_docstring_of_Enum branch from eb44f0b to d95098e Compare May 7, 2022 17:55
@bedevere-bot bedevere-bot mentioned this pull request Dec 7, 2022
Closed
@netlify
Copy link

netlify bot commented Dec 7, 2022 •
edited
Loading

✅ Deploy Preview for python-cpython-preview canceled.

Name Link
🔨 Latest commit 61c60b9
🔍 Latest deploy log https://app.netlify.com/sites/python-cpython-preview/deploys/6390cf790be2c70009088bad

@ethanfurman ethanfurman merged commit 90d5c9b into python:main Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ethanfurman ethanfurman ethanfurman approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees

@ethanfurman ethanfurman

Labels
stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

The docstring of enum.Enum is invalid in reStructuredText since 3.11
6 participants
@tk0miya @hugovk @ethanfurman @AA-Turner @bedevere-bot @AlexWaygood