https://github.com/python/cpython/commit/ca3eca1584c948d075eee904ad8f1bb910894212
commit: ca3eca1584c948d075eee904ad8f1bb910894212
branch: 3.11
author: Nikita Sobolev <[email protected]>
committer: ethanfurman <[email protected]>
date: 2024-02-09T12:09:59-08:00
summary:
[3.11] gh-101100: Fix sphinx warnings in `library/enum.rst` (GH-114696)
(GH-115209)
files:
M Doc/library/enum.rst
M Doc/tools/.nitignore
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index fd34fcd52637aa..5516eaaf1ef0ff 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -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
@@ -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::
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index e7a29348a4df0b..785836d8e757e4 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -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
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
