Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 01cc2d5

Browse files
committed
Issue20653: fix ReST for Enum
1 parent 2da9504 commit 01cc2d5

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

Doc/library/enum.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ The solution is to specify the module name explicitly as follows::
425425

426426
.. warning::
427427

428-
If :param module: is not supplied, and Enum cannot determine what it is,
428+
If ``module`` is not supplied, and Enum cannot determine what it is,
429429
the new Enum members will not be unpicklable; to keep errors closer to
430430
the source, pickling will be disabled.
431431

@@ -440,26 +440,26 @@ The complete signature is::
440440

441441
Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=<mixed-in class>)
442442

443-
:param value: What the new Enum class will record as its name.
443+
:value: What the new Enum class will record as its name.
444444

445-
:param names: The Enum members. This can be a whitespace or comma seperated
446-
string::
445+
:names: The Enum members. This can be a whitespace or comma seperated string
446+
(values will start at 1)::
447447

448-
'red green blue', 'red,green,blue', 'red, green, blue'
448+
'red green blue' | 'red,green,blue' | 'red, green, blue'
449449

450-
(values will start at 1), or an iterator of name, value pairs::
450+
or an iterator of (name, value) pairs::
451451

452452
[('cyan', 4), ('magenta', 5), ('yellow', 6)]
453453

454-
or a mapping::
454+
or a mapping::
455455

456456
{'chartruese': 7, 'sea_green': 11, 'rosemary': 42}
457457

458-
:param module: name of module where new Enum class can be found.
458+
:module: name of module where new Enum class can be found.
459459

460-
:param qualname: where in module new Enum class can be found.
460+
:qualname: where in module new Enum class can be found.
461461

462-
:param type: type to mix in to new Enum class.
462+
:type: type to mix in to new Enum class.
463463

464464

465465
Derived Enumerations

0 commit comments

Comments
 (0)