Skip to content

[3.13] gh-136672: Docs: Move Enum functions and add examples (GH-136791) #137689

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

Merged
merged 1 commit into from
Aug 12, 2025

Conversation

miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Aug 12, 2025

  • Docs: Move Enum functions and add examples

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.


(cherry picked from commit 003bd8c)

Co-authored-by: RafaelWO 38643099+RafaelWO@users.noreply.github.com
Co-authored-by: Ethan Furman ethan@stoneleaf.us


📚 Documentation preview 📚: https://cpython-previews--137689.org.readthedocs.build/

…-136791)

* Docs: Move Enum functions and add examples

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.

---------
(cherry picked from commit 003bd8c)

Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Aug 12, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Aug 12, 2025
@bedevere-app bedevere-app bot added the sprint label Aug 12, 2025
@AA-Turner AA-Turner merged commit 85637f0 into python:3.13 Aug 12, 2025
30 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news sprint
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants