Issue22997: minor doc update; thanks to Simoen Visser

This commit is contained in:
Ethan Furman 2015-01-14 22:32:29 -08:00
commit 61f50bb488
1 changed files with 7 additions and 3 deletions

View File

@ -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 new class derived from :class:`Enum` is returned. In other words, the above
assignment to :class:`Animal` is equivalent to:: assignment to :class:`Animal` is equivalent to::
>>> class Animals(Enum): >>> class Animal(Enum):
... ant = 1 ... ant = 1
... bee = 2 ... bee = 2
... cat = 3 ... 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). function in separate module, and also may not work on IronPython or Jython).
The solution is to specify the module name explicitly as follows:: 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:: .. 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 to find the class. For example, if the class was made available in class
SomeData in the global scope:: 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:: The complete signature is::
@ -448,6 +448,10 @@ The complete signature is::
'red green blue' | 'red,green,blue' | 'red, green, blue' 'red green blue' | 'red,green,blue' | 'red, green, blue'
or an iterator of names::
['red', 'green', 'blue']
or an iterator of (name, value) pairs:: or an iterator of (name, value) pairs::
[('cyan', 4), ('magenta', 5), ('yellow', 6)] [('cyan', 4), ('magenta', 5), ('yellow', 6)]