summaryrefslogtreecommitdiff
path: root/Doc/library/enum.rst
diff options
context:
space:
mode:
authorEthan Furman <ethan@stoneleaf.us>2015-01-14 22:32:29 -0800
committerEthan Furman <ethan@stoneleaf.us>2015-01-14 22:32:29 -0800
commit52a77ee6e90784d1369d8be0b03274f956f89252 (patch)
treed389498efc0437da1eff40f957df0ceebd323ac3 /Doc/library/enum.rst
parented258b425e226d53c7fbbc3640bd1858976a340d (diff)
parentf44257b2576f52e692821904b3dbefadb2eafd3c (diff)
downloadcpython-52a77ee6e90784d1369d8be0b03274f956f89252.tar.gz
Issue22997: minor doc update; thanks to Simoen Visser
Diffstat (limited to 'Doc/library/enum.rst')
-rw-r--r--Doc/library/enum.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index f75c43c7f2..d3b838c01c 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -405,7 +405,7 @@ the ``start`` parameter to specify a different starting value). A
new class derived from :class:`Enum` is returned. In other words, the above
assignment to :class:`Animal` is equivalent to::
- >>> class Animals(Enum):
+ >>> class Animal(Enum):
... ant = 1
... bee = 2
... cat = 3
@@ -422,7 +422,7 @@ enumeration is being created in (e.g. it will fail if you use a utility
function in separate module, and also may not work on IronPython or Jython).
The solution is to specify the module name explicitly as follows::
- >>> Animals = Enum('Animals', 'ant bee cat dog', module=__name__)
+ >>> Animal = Enum('Animal', 'ant bee cat dog', module=__name__)
.. warning::
@@ -435,7 +435,7 @@ The new pickle protocol 4 also, in some circumstances, relies on
to find the class. For example, if the class was made available in class
SomeData in the global scope::
- >>> Animals = Enum('Animals', 'ant bee cat dog', qualname='SomeData.Animals')
+ >>> Animal = Enum('Animal', 'ant bee cat dog', qualname='SomeData.Animal')
The complete signature is::
@@ -448,6 +448,10 @@ The complete signature is::
'red green blue' | 'red,green,blue' | 'red, green, blue'
+ or an iterator of names::
+
+ ['red', 'green', 'blue']
+
or an iterator of (name, value) pairs::
[('cyan', 4), ('magenta', 5), ('yellow', 6)]