[Python-checkins] Minor documentation fixes on library/enum (GH-15234)
Ethan Furman
webhook-mailer at python.org
Mon Aug 19 21:41:35 EDT 2019
https://github.com/python/cpython/commit/d3c8d735147ccdde1f9bf18ba481da67564837bf
commit: d3c8d735147ccdde1f9bf18ba481da67564837bf
branch: master
author: Antoine <43954001+awecx at users.noreply.github.com>
committer: Ethan Furman <ethan at stoneleaf.us>
date: 2019-08-19T18:41:31-07:00
summary:
Minor documentation fixes on library/enum (GH-15234)
* Minor documentation fixes on library/enum
files:
M Doc/library/enum.rst
M Misc/ACKS
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index d7d319a95134..1d6912aaf19a 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -383,8 +383,8 @@ enumeration, with the exception of special methods (:meth:`__str__`,
variable names listed in :attr:`_ignore_`.
Note: if your enumeration defines :meth:`__new__` and/or :meth:`__init__` then
-whatever value(s) were given to the enum member will be passed into those
-methods. See `Planet`_ for an example.
+any value(s) given to the enum member will be passed into those methods.
+See `Planet`_ for an example.
Restricted Enum subclassing
@@ -730,8 +730,7 @@ Some rules:
2. While :class:`Enum` can have members of any type, once you mix in an
additional type, all the members must have values of that type, e.g.
:class:`int` above. This restriction does not apply to mix-ins which only
- add methods and don't specify another data type such as :class:`int` or
- :class:`str`.
+ add methods and don't specify another type.
3. When another data type is mixed in, the :attr:`value` attribute is *not the
same* as the enum member itself, although it is equivalent and will compare
equal.
@@ -1054,7 +1053,7 @@ Supported ``_sunder_`` names
- ``_missing_`` -- a lookup function used when a value is not found; may be
overridden
-- ``_ignore_`` -- a list of names, either as a :func:`list` or a :func:`str`,
+- ``_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
diff --git a/Misc/ACKS b/Misc/ACKS
index 52a5d70e5e2d..3a796860b798 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1771,6 +1771,7 @@ Steve Weber
Corran Webster
Glyn Webster
Phil Webster
+Antoine Wecxsteen
Stefan Wehr
Zack Weinberg
Bob Weiner
More information about the Python-checkins
mailing list