From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 7 May 2024 12:02:55 +0000 (+0200)
Subject: [3.12] gh-118310: Fix documentation for `enum.Enum.__new__` (GH-118311) (GH-118699)
X-Git-Tag: v3.12.4~128
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8e53f66797718a12bad7c6b50b93c8062d062a82;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-118310: Fix documentation for `enum.Enum.__new__` (GH-118311) (GH-118699)

gh-118310: Fix documentation for `enum.Enum.__new__` (GH-118311)

The provided example was incorrect:
- The example enum was missing the `int` mixin as implied by the context
- The value of `int('1a', 16)` was incorrectly given as 17
  (should be 26)
(cherry picked from commit 48e52fe2c9a7b33671f6b5d1420a71a6f31ad64b)

Co-authored-by: Momo Eissenhauer <mmEissen@users.noreply.github.com>
---

diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index faeb94d66069..18b54a4941b6 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -392,13 +392,15 @@ Data Types
       in the member assignment will be passed; e.g.
 
          >>> from enum import Enum
-         >>> class MyIntEnum(Enum):
-         ...     SEVENTEEN = '1a', 16
+         >>> class MyIntEnum(int, Enum):
+         ...     TWENTYSIX = '1a', 16
 
-      results in the call ``int('1a', 16)`` and a value of ``17`` for the member.
+      results in the call ``int('1a', 16)`` and a value of ``26`` for the member.
 
-      .. note:: When writing a custom ``__new__``, do not use ``super().__new__`` --
-                call the appropriate ``__new__`` instead.
+      .. note::
+
+         When writing a custom ``__new__``, do not use ``super().__new__`` --
+         call the appropriate ``__new__`` instead.
 
    .. method:: Enum.__repr__(self)