mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-26 13:22:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Close issue21706: add 'start' parameter to functional API

Browse source
This commit is contained in:
Ethan Furman 2014-09-16 20:35:55 -07:00
parent 52351c7037
commit d9925a18ec
3 changed files with 80 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/enum.rst
View file

@ -400,7 +400,8 @@ The second argument is the *source* of enumeration member names. It can be a
whitespace-separated string of names, a sequence of names, a sequence of
2-tuples with key/value pairs, or a mapping (e.g. dictionary) of names to
values. The last two options enable assigning arbitrary values to
enumerations; the others auto-assign increasing integers starting with 1. A
enumerations; the others auto-assign increasing integers starting with 1 (use
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::
@ -438,12 +439,12 @@ SomeData in the global scope::
The complete signature is::
Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=<mixed-in class>)
Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=<mixed-in class>, start=1)
:value: What the new Enum class will record as its name.
:names: The Enum members. This can be a whitespace or comma separated string
(values will start at 1)::
(values will start at 1 unless otherwise specified)::
'red green blue' | 'red,green,blue' | 'red, green, blue'
@ -461,6 +462,8 @@ The complete signature is::
:type: type to mix in to new Enum class.
:start: number to start counting at if only names are passed in
Derived Enumerations
--------------------