Skip to content

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

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

Open
wants to merge 1 commit into
base: 3.14
Choose a base branch
from

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--137688.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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

3 participants