]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101100: Fix sphinx warnings in `library/enum.rst` (#114696)
authorNikita Sobolev <mail@sobolevn.me>
Fri, 9 Feb 2024 06:40:28 +0000 (09:40 +0300)
committerGitHub <noreply@github.com>
Fri, 9 Feb 2024 06:40:28 +0000 (23:40 -0700)
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
Doc/library/enum.rst
Doc/tools/.nitignore

index 534939943d33267df42dff5261219ae96a841488..30d80ce8d488ccb366d102bd6a8df00590850f02 100644 (file)
@@ -286,6 +286,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
@@ -823,8 +836,8 @@ Supported ``_sunder_`` names
 - :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_` -- used in Python 2/3 code to ensure member order is
-  consistent (class attribute, removed during class creation)
+- :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
 
index f96478b45e44c00c21f51c7c5c03f51f9078465c..9db02c5c3c73c902ff60267a474fb0cec9453cc8 100644 (file)
@@ -31,7 +31,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