gh-136672: Docs: Move Enum functions and add examples #136791
+33
−19
Conversation
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
bedevere-app
bot
added
awaiting review
docs
|
Thanks for reviewing, @AA-Turner 🙃 |
When the `Enum` functions `_add_alias_` and `_add_value_alias_` were added in de6bca9, the documentation for them was done under `EnumType` instead of `Enum`. This change moves them to the docs of the `Enum` class and adds an example for each function.
This change moves the `versionadded` for `EnumType` to the top. Additionally, it fixes the indentation of another `versionchanged` entry.
RafaelWO
force-pushed
the
change/docs-move-enum-functions-and-add-examples
branch
from
69e75be to
4b25a5f
Compare
ethanfurman
requested changes
Jul 19, 2025
Comment on lines
+881
to
884
| - :meth:`~Enum._add_alias_` -- adds a new name as an alias to an existing | ||
| member. | ||
| - :meth:`~EnumType._add_value_alias_` -- adds a new value as an alias to an | ||
| - :meth:`~Enum._add_value_alias_` -- adds a new value as an alias to an | ||
| existing member. |
There was a problem hiding this comment.
Please move these lines to the bottom of the list.
|
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 |
AA-Turner
added
needs backport to 3.13
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the
Enumfunctions_add_alias_and_add_value_alias_were added in de6bca9, the documentation for them was done underEnumTypeinstead ofEnum.This change moves them to the docs of the
Enumclass and adds an example for each function.Additionally, it moves the
versionaddedforEnumTypeto the top and fixes the indentation of anotherversionchangedentry.📚 Documentation preview 📚: https://cpython-previews--136791.org.readthedocs.build/