diff options
author | Ethan Furman <ethan@stoneleaf.us> | 2014-03-03 23:02:04 (GMT) |
---|---|---|
committer | Ethan Furman <ethan@stoneleaf.us> | 2014-03-03 23:02:04 (GMT) |
commit | c913a7a6f68044584f7bee90ba85d5c27e7859fe (patch) | |
tree | c6ffdc6caa1a984b5d97b052aa1af02870258bc2 /Doc/library | |
parent | 9c4544472734246195f28c2404190c7b33009db8 (diff) | |
download | cpython-c913a7a6f68044584f7bee90ba85d5c27e7859fe.zip cpython-c913a7a6f68044584f7bee90ba85d5c27e7859fe.tar.gz cpython-c913a7a6f68044584f7bee90ba85d5c27e7859fe.tar.bz2 |
Issue20653: fix ReST for Enum
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/enum.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index eb5bdd98..fc7267b 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -425,7 +425,7 @@ The solution is to specify the module name explicitly as follows:: .. warning:: - If :param module: is not supplied, and Enum cannot determine what it is, + If ``module`` is not supplied, and Enum cannot determine what it is, the new Enum members will not be unpicklable; to keep errors closer to the source, pickling will be disabled. @@ -440,26 +440,26 @@ The complete signature is:: Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=<mixed-in class>) -:param value: What the new Enum class will record as its name. +:value: What the new Enum class will record as its name. -:param names: The Enum members. This can be a whitespace or comma seperated -string:: +:names: The Enum members. This can be a whitespace or comma seperated string + (values will start at 1):: - 'red green blue', 'red,green,blue', 'red, green, blue' + 'red green blue' | 'red,green,blue' | 'red, green, blue' -(values will start at 1), or an iterator of name, value pairs:: + or an iterator of (name, value) pairs:: [('cyan', 4), ('magenta', 5), ('yellow', 6)] -or a mapping:: + or a mapping:: {'chartruese': 7, 'sea_green': 11, 'rosemary': 42} -:param module: name of module where new Enum class can be found. +:module: name of module where new Enum class can be found. -:param qualname: where in module new Enum class can be found. +:qualname: where in module new Enum class can be found. -:param type: type to mix in to new Enum class. +:type: type to mix in to new Enum class. Derived Enumerations |