summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorEthan Furman <ethan@stoneleaf.us>2020-12-10 20:20:06 (GMT)
committerGitHub <noreply@github.com>2020-12-10 20:20:06 (GMT)
commitefb13be72cbf49edf591936fafb120fe1b7d59f7 (patch)
treeb35ffdea85d002cac1789a48c99287e5ca75a358 /Doc/library
parent9fc571359af9320fddbe4aa2710a767f168c1707 (diff)
downloadcpython-efb13be72cbf49edf591936fafb120fe1b7d59f7.zip
cpython-efb13be72cbf49edf591936fafb120fe1b7d59f7.tar.gz
cpython-efb13be72cbf49edf591936fafb120fe1b7d59f7.tar.bz2
bpo-42385: [Enum] add `_generate_next_value_` to StrEnum (GH-23735)
The default for auto() is to return an integer, which doesn't work for `StrEnum`. The new `_generate_next_value_` for `StrEnum` returns the member name, lower cased.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/enum.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index a9584b9..a0b078c 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -67,10 +67,12 @@ helper, :class:`auto`.
.. class:: auto
- Instances are replaced with an appropriate value for Enum members. By default, the initial value starts at 1.
+ Instances are replaced with an appropriate value for Enum members.
+ :class:`StrEnum` defaults to the lower-cased version of the member name,
+ while other Enums default to 1 and increase from there.
.. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto``
-
+.. versionadded:: 3.10 ``StrEnum``
Creating an Enum
----------------