From: Ethan Furman Date: Sat, 1 Nov 2014 14:40:22 +0000 (-0700) Subject: standardize Enum docs by referring to 'special methods' instead of __dunder__ methods X-Git-Tag: v3.5.0a1~547 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8be6fac103b108c3bfac8e91a08ab2671c4537d3;p=python standardize Enum docs by referring to 'special methods' instead of __dunder__ methods --- diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 743a211ff2..f75c43c7f2 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