Skip to content

Commit

Permalink
[3.11] pythongh-101100: Fix sphinx warnings in library/enum.rst (py…
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn committed Feb 9, 2024
1 parent 20c6535 commit f7548d4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 13 deletions.
36 changes: 24 additions & 12 deletions Doc/library/enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,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
Expand Down Expand Up @@ -766,18 +779,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::

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,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
Expand Down

0 comments on commit f7548d4

Please sign in to comment.