]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] docs: add a more precise example in enum doc (GH-121015) (#126307)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 1 Nov 2024 23:18:00 +0000 (00:18 +0100)
committerGitHub <noreply@github.com>
Fri, 1 Nov 2024 23:18:00 +0000 (16:18 -0700)
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 ff257c7843d8ed0dffb6624f2f14996a46e74801)

Co-authored-by: Filip "Ret2Me" Poplewski <37419029+Ret2Me@users.noreply.github.com>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
Doc/library/enum.rst

index 6e2872b9c707310ab944503dbd2159132545d0a8..a4b6a53d29ee354bb874e1769ca069d384ce9b18 100644 (file)
@@ -44,7 +44,7 @@ using function-call syntax::
    ...     BLUE = 3
 
    >>> # functional syntax
-   >>> Color = Enum('Color', ['RED', 'GREEN', 'BLUE'])
+   >>> Color = Enum('Color', [('RED', 1), ('GREEN', 2), ('BLUE', 3)])
 
 Even though we can use :keyword:`class` syntax to create Enums, Enums
 are not normal Python classes.  See