Skip to content

Commit 3539b02

Browse files
authored
[3.12] gh-101100: Fix sphinx warnings in library/enum.rst (GH-114696) (GH-115208)
1 parent 370cbbb commit 3539b02

File tree

2 files changed

+28
-13
lines changed

2 files changed

+28
-13
lines changed

Doc/library/enum.rst

+28-12
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,10 @@ Data Types
235235
>>> len(Color)
236236
3
237237

238+
.. attribute:: EnumType.__members__
239+
240+
Returns a mapping of every enum name to its member, including aliases
241+
238242
.. method:: EnumType.__reversed__(cls)
239243

240244
Returns each member in *cls* in reverse definition order::
@@ -272,6 +276,19 @@ Data Types
272276
appropriate value will be chosen for you. See :class:`auto` for the
273277
details.
274278

279+
.. attribute:: Enum._name_
280+
281+
Name of the member.
282+
283+
.. attribute:: Enum._value_
284+
285+
Value of the member, can be set in :meth:`~object.__new__`.
286+
287+
.. attribute:: Enum._order_
288+
289+
No longer used, kept for backward compatibility.
290+
(class attribute, removed during class creation).
291+
275292
.. attribute:: Enum._ignore_
276293

277294
``_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.
798815
Supported ``_sunder_`` names
799816
""""""""""""""""""""""""""""
800817

801-
- ``_name_`` -- name of the member
802-
- ``_value_`` -- value of the member; can be set / modified in ``__new__``
803-
804-
- ``_missing_`` -- a lookup function used when a value is not found; may be
805-
overridden
806-
- ``_ignore_`` -- a list of names, either as a :class:`list` or a :class:`str`,
807-
that will not be transformed into members, and will be removed from the final
808-
class
809-
- ``_order_`` -- used in Python 2/3 code to ensure member order is consistent
810-
(class attribute, removed during class creation)
811-
- ``_generate_next_value_`` -- used to get an appropriate value for an enum
812-
member; may be overridden
818+
- :attr:`~Enum._name_` -- name of the member
819+
- :attr:`~Enum._value_` -- value of the member; can be set in ``__new__``
820+
- :meth:`~Enum._missing_` -- a lookup function used when a value is not found;
821+
may be overridden
822+
- :attr:`~Enum._ignore_` -- a list of names, either as a :class:`list` or a
823+
:class:`str`, that will not be transformed into members, and will be removed
824+
from the final class
825+
- :attr:`~Enum._order_` -- no longer used, kept for backward
826+
compatibility (class attribute, removed during class creation)
827+
- :meth:`~Enum._generate_next_value_` -- used to get an appropriate value for
828+
an enum member; may be overridden
813829

814830
.. note::
815831

Doc/tools/.nitignore

-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ Doc/library/email.compat32-message.rst
3939
Doc/library/email.errors.rst
4040
Doc/library/email.parser.rst
4141
Doc/library/email.policy.rst
42-
Doc/library/enum.rst
4342
Doc/library/exceptions.rst
4443
Doc/library/faulthandler.rst
4544
Doc/library/fcntl.rst

0 commit comments

Comments
 (0)