mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-02 05:12:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.11] gh-101100: [Enum] Fix sphinx warnings in docs (GH-101122) (#101173)

Browse source 
(cherry picked from commit 9e025d305f)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
This commit is contained in:
Miss Islington (bot) 2023-01-20 14:07:23 -08:00 • committed by GitHub
parent 5e1c4ac85e
commit e039d53dae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Doc/library/enum.rst
View file

@ -52,11 +52,11 @@ are not normal Python classes. See
.. note:: Nomenclature .. note:: Nomenclature
- The class :class:`Color` is an *enumeration* (or *enum*) - The class :class:`!Color` is an *enumeration* (or *enum*)
- The attributes :attr:`Color.RED`, :attr:`Color.GREEN`, etc., are - The attributes :attr:`!Color.RED`, :attr:`!Color.GREEN`, etc., are
*enumeration members* (or *members*) and are functionally constants. *enumeration members* (or *members*) and are functionally constants.
- The enum members have *names* and *values* (the name of - The enum members have *names* and *values* (the name of
:attr:`Color.RED` is ``RED``, the value of :attr:`Color.BLUE` is :attr:`!Color.RED` is ``RED``, the value of :attr:`!Color.BLUE` is
``3``, etc.) ``3``, etc.)
--------------- ---------------
@ -165,8 +165,8 @@ Data Types
to subclass *EnumType* -- see :ref:`Subclassing EnumType <enumtype-examples>` to subclass *EnumType* -- see :ref:`Subclassing EnumType <enumtype-examples>`
for details. for details.
*EnumType* is responsible for setting the correct :meth:`__repr__`, *EnumType* is responsible for setting the correct :meth:`!__repr__`,
:meth:`__str__`, :meth:`__format__`, and :meth:`__reduce__` methods on the :meth:`!__str__`, :meth:`!__format__`, and :meth:`!__reduce__` methods on the
final *enum*, as well as creating the enum members, properly handling final *enum*, as well as creating the enum members, properly handling
duplicates, providing iteration over the enum class, etc. duplicates, providing iteration over the enum class, etc.
@ -422,9 +422,9 @@ Data Types
Using :class:`auto` with :class:`IntEnum` results in integers of increasing Using :class:`auto` with :class:`IntEnum` results in integers of increasing
value, starting with ``1``. value, starting with ``1``.
.. versionchanged:: 3.11 :meth:`__str__` is now :func:`int.__str__` to .. versionchanged:: 3.11 :meth:`~object.__str__` is now :meth:`!int.__str__` to
better support the *replacement of existing constants* use-case. better support the *replacement of existing constants* use-case.
:meth:`__format__` was already :func:`int.__format__` for that same reason. :meth:`~object.__format__` was already :meth:`!int.__format__` for that same reason.
.. class:: StrEnum .. class:: StrEnum
@ -753,11 +753,11 @@ Data Types
Supported ``__dunder__`` names Supported ``__dunder__`` names
"""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""
:attr:`__members__` is a read-only ordered mapping of ``member_name``:``member`` :attr:`~EnumType.__members__` is a read-only ordered mapping of ``member_name``:``member``
items. It is only available on the class. items. It is only available on the class.
:meth:`__new__`, if specified, must create and return the enum members; it is :meth:`~object.__new__`, if specified, must create and return the enum members; it is
also a very good idea to set the member's :attr:`_value_` appropriately. Once also a very good idea to set the member's :attr:`!_value_` appropriately. Once
all the members are created it is no longer used. all the members are created it is no longer used.
@ -796,7 +796,7 @@ Utilities and Decorators
.. class:: auto .. class:: auto
*auto* can be used in place of a value. If used, the *Enum* machinery will *auto* can be used in place of a value. If used, the *Enum* machinery will
call an *Enum*'s :meth:`_generate_next_value_` to get an appropriate value. call an *Enum*'s :meth:`~Enum._generate_next_value_` to get an appropriate value.
For *Enum* and *IntEnum* that appropriate value will be the last value plus For *Enum* and *IntEnum* that appropriate value will be the last value plus
one; for *Flag* and *IntFlag* it will be the first power-of-two greater one; for *Flag* and *IntFlag* it will be the first power-of-two greater
than the highest value; for *StrEnum* it will be the lower-cased version of than the highest value; for *StrEnum* it will be the lower-cased version of
@ -839,7 +839,7 @@ Utilities and Decorators
.. decorator:: unique .. decorator:: unique
A :keyword:`class` decorator specifically for enumerations. It searches an A :keyword:`class` decorator specifically for enumerations. It searches an
enumeration's :attr:`__members__`, gathering any aliases it finds; if any are enumeration's :attr:`~EnumType.__members__`, gathering any aliases it finds; if any are
found :exc:`ValueError` is raised with the details:: found :exc:`ValueError` is raised with the details::
>>> from enum import Enum, unique >>> from enum import Enum, unique