]> granicus.if.org Git - python/commitdiff
standardize Enum docs by referring to 'special methods' instead of __dunder__ methods
authorEthan Furman <ethan@stoneleaf.us>
Sat, 1 Nov 2014 14:40:22 +0000 (07:40 -0700)
committerEthan Furman <ethan@stoneleaf.us>
Sat, 1 Nov 2014 14:40:22 +0000 (07:40 -0700)
Doc/library/enum.rst

index 743a211ff2e6aaabc73c2fd134cd22cf1e7d9316..f75c43c7f2fea7f44ae4a5eb8c3720fd02869e00 100644 (file)
@@ -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