summaryrefslogtreecommitdiffstats
path: root/Doc/library/enum.rst
diff options
context:
space:
mode:
authorEthan Furman <ethan@stoneleaf.us>2014-11-01 14:40:22 (GMT)
committerEthan Furman <ethan@stoneleaf.us>2014-11-01 14:40:22 (GMT)
commit8be6fac103b108c3bfac8e91a08ab2671c4537d3 (patch)
tree1b86683d27bf7fdab9015812ee8cf47cc23c7f71 /Doc/library/enum.rst
parent89122706296148dad0994b6c9b317af77e0ada58 (diff)
downloadcpython-8be6fac103b108c3bfac8e91a08ab2671c4537d3.zip
cpython-8be6fac103b108c3bfac8e91a08ab2671c4537d3.tar.gz
cpython-8be6fac103b108c3bfac8e91a08ab2671c4537d3.tar.bz2
standardize Enum docs by referring to 'special methods' instead of __dunder__ methods
Diffstat (limited to 'Doc/library/enum.rst')
-rw-r--r--Doc/library/enum.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index 743a211..f75c43c 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -314,11 +314,11 @@ Then::
>>> str(Mood.funky)
'my custom str! 1'
-The rules for what is allowed are as follows: _sunder_ names (starting and
-ending with a single underscore) are reserved by enum and cannot be used;
-all other attributes defined within an enumeration will become members of this
-enumeration, with the exception of *__dunder__* names and descriptors (methods
-are also descriptors).
+The rules for what is allowed are as follows: names that start and end with a
+with a single underscore are reserved by enum and cannot be used; all other
+attributes defined within an enumeration will become members of this
+enumeration, with the exception of special methods (:meth:`__str__`,
+:meth:`__add__`, etc.) and descriptors (methods are also descriptors).
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