Skip to content

gh-107957: Fix dir() sample output in enum docs #107958

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.

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

Closed
wants to merge 9 commits into from
Closed

gh-107957: Fix dir() sample output in enum docs #107958

wants to merge 9 commits into from

Conversation

ujan-r
Copy link

@ujan-r ujan-r commented Aug 15, 2023

@ujan-r ujan-r requested a review from ethanfurman as a code owner August 15, 2023 01:48
@ghost
Copy link

ghost commented Aug 15, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some initial comments:

A

Comment on lines +1058 to +1060
.. versionchanged:: 3.11
Additional ``__dunder__`` names are returned for enums and enum members.
Calling :func:`dir` on an enum member also returns the other members.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need versionchanged in a How To document

Suggested change
.. versionchanged:: 3.11
Additional ``__dunder__`` names are returned for enums and enum members.
Calling :func:`dir` on an enum member also returns the other members.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I remove it? Note that there are 13 other occurrences of versionadded/versionchanged in the document

@ethanfurman
Copy link
Member

These issues have been handled elsewhere -- specifically, __dir__ was updated to not display the members. Opened a new PR to acknowledge Ujan's contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants