Skip to content

Commit

Permalink
Fix documentation for enum.Enum.__new__
Browse files Browse the repository at this point in the history
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)
- The `.. note` tag was missing a space
- Fix the indent to match other note tags
  • Loading branch information
Momo Eissenhauer committed Apr 26, 2024
1 parent ef940de commit c308b9b
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions Doc/library/enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -402,13 +402,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)

Expand Down

0 comments on commit c308b9b

Please sign in to comment.