FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-107957: Fix `dir()` sample output in `enum` docs by ujan-r · Pull Request #107958 · python/cpython · GitHub

Repository navigation

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

Closed
ujan-r wants to merge 9 commits into
python:mainfrom
ujan-r:enum-doc-fix
Closed

ujan-r wants to merge 9 commits into
python:mainfrom
ujan-r:enum-doc-fix

Conversation

ujan-r commented Aug 15, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown

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

ghost commented Aug 15, 2023 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

AA-Turner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Some initial comments:

A

Comment thread Doc/howto/enum.rst
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
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread Doc/howto/enum.rst
Comment thread Doc/library/enum.rst Outdated

Copy link
Copy Markdown
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.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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


Back | FazBrowse Home | New Git URL