-
-
Notifications
You must be signed in to change notification settings - Fork 30.3k
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
docs: add a more precise example #121015
docs: add a more precise example #121015
Conversation
Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of the changes are not necessary. I would accept a second example, similar to your proposed example, of ...[('RED', 1), ('GREEN', 2), ...
.
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
I have made the requested changes; please review again |
Thanks for making the requested changes! @ethanfurman: please review the changes made to this pull request. |
@ethanfurman I'm triaging open doc PRs. Do you want to review this one again? Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ethanfurman for the new review and @Ret2Me for the contribution.
* docs: add a more precise example Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment. * docs: remove whitespace characters * refactor: change example --------- (cherry picked from commit ff257c7) Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]> Co-authored-by: Ethan Furman <[email protected]>
* docs: add a more precise example Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment. * docs: remove whitespace characters * refactor: change example --------- (cherry picked from commit ff257c7) Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]> Co-authored-by: Ethan Furman <[email protected]>
GH-126306 is a backport of this pull request to the 3.13 branch. |
GH-126307 is a backport of this pull request to the 3.12 branch. |
) docs: add a more precise example in enum doc (GH-121015) * docs: add a more precise example Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment. * docs: remove whitespace characters * refactor: change example --------- (cherry picked from commit ff257c7) Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]> Co-authored-by: Ethan Furman <[email protected]>
) docs: add a more precise example in enum doc (GH-121015) * docs: add a more precise example Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment. * docs: remove whitespace characters * refactor: change example --------- (cherry picked from commit ff257c7) Co-authored-by: Filip "Ret2Me" Poplewski <[email protected]> Co-authored-by: Ethan Furman <[email protected]>
Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users.
Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment.
📚 Documentation preview 📚: https://cpython-previews--121015.org.readthedocs.build/