mirror of
https://github.com/python/cpython.git
synced 2026-01-04 14:32:21 +00:00
[3.12] gh-101100: Fix sphinx warnings in library/enum.rst (GH-114696) (GH-115208)
This commit is contained in:
parent
370cbbbfeb
commit
3539b02873
2 changed files with 28 additions and 13 deletions
|
|
@ -235,6 +235,10 @@ Data Types
|
|||
>>> len(Color)
|
||||
3
|
||||
|
||||
.. attribute:: EnumType.__members__
|
||||
|
||||
Returns a mapping of every enum name to its member, including aliases
|
||||
|
||||
.. method:: EnumType.__reversed__(cls)
|
||||
|
||||
Returns each member in *cls* in reverse definition order::
|
||||
|
|
@ -272,6 +276,19 @@ Data Types
|
|||
appropriate value will be chosen for you. See :class:`auto` for the
|
||||
details.
|
||||
|
||||
.. attribute:: Enum._name_
|
||||
|
||||
Name of the member.
|
||||
|
||||
.. attribute:: Enum._value_
|
||||
|
||||
Value of the member, can be set in :meth:`~object.__new__`.
|
||||
|
||||
.. attribute:: Enum._order_
|
||||
|
||||
No longer used, kept for backward compatibility.
|
||||
(class attribute, removed during class creation).
|
||||
|
||||
.. attribute:: Enum._ignore_
|
||||
|
||||
``_ignore_`` is only used during creation and is removed from the
|
||||
|
|
@ -798,18 +815,17 @@ all the members are created it is no longer used.
|
|||
Supported ``_sunder_`` names
|
||||
""""""""""""""""""""""""""""
|
||||
|
||||
- ``_name_`` -- name of the member
|
||||
- ``_value_`` -- value of the member; can be set / modified in ``__new__``
|
||||
|
||||
- ``_missing_`` -- a lookup function used when a value is not found; may be
|
||||
overridden
|
||||
- ``_ignore_`` -- a list of names, either as a :class:`list` or a :class:`str`,
|
||||
that will not be transformed into members, and will be removed from the final
|
||||
class
|
||||
- ``_order_`` -- used in Python 2/3 code to ensure member order is consistent
|
||||
(class attribute, removed during class creation)
|
||||
- ``_generate_next_value_`` -- used to get an appropriate value for an enum
|
||||
member; may be overridden
|
||||
- :attr:`~Enum._name_` -- name of the member
|
||||
- :attr:`~Enum._value_` -- value of the member; can be set in ``__new__``
|
||||
- :meth:`~Enum._missing_` -- a lookup function used when a value is not found;
|
||||
may be overridden
|
||||
- :attr:`~Enum._ignore_` -- a list of names, either as a :class:`list` or a
|
||||
:class:`str`, that will not be transformed into members, and will be removed
|
||||
from the final class
|
||||
- :attr:`~Enum._order_` -- no longer used, kept for backward
|
||||
compatibility (class attribute, removed during class creation)
|
||||
- :meth:`~Enum._generate_next_value_` -- used to get an appropriate value for
|
||||
an enum member; may be overridden
|
||||
|
||||
.. note::
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,6 @@ Doc/library/email.compat32-message.rst
|
|||
Doc/library/email.errors.rst
|
||||
Doc/library/email.parser.rst
|
||||
Doc/library/email.policy.rst
|
||||
Doc/library/enum.rst
|
||||
Doc/library/exceptions.rst
|
||||
Doc/library/faulthandler.rst
|
||||
Doc/library/fcntl.rst
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue