diff options
| author | Ethan Furman <ethan@stoneleaf.us> | 2013-09-09 06:48:34 (GMT) |
|---|---|---|
| committer | Ethan Furman <ethan@stoneleaf.us> | 2013-09-09 06:48:34 (GMT) |
| commit | 455bfdea2fd24e5b5f966860b9987fd6321dcde0 (patch) | |
| tree | d78c438a8ae3f1e22b64e94b4e262a621aa3a3ae /Doc/library/enum.rst | |
| parent | 8df58f7ae87a2debeae47813537d5c105bea6f38 (diff) | |
| download | cpython-455bfdea2fd24e5b5f966860b9987fd6321dcde0.zip cpython-455bfdea2fd24e5b5f966860b9987fd6321dcde0.tar.gz cpython-455bfdea2fd24e5b5f966860b9987fd6321dcde0.tar.bz2 | |
Close #18980: Enum doc fixes. Patch from Elazar Gershuni.
Diffstat (limited to 'Doc/library/enum.rst')
| -rw-r--r-- | Doc/library/enum.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 3661469..236275d 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -38,7 +38,8 @@ follows:: ... blue = 3 ... -..note: Nomenclature +.. note:: Nomenclature + - The class :class:`Color` is an *enumeration* (or *enum*) - The attributes :attr:`Color.red`, :attr:`Color.green`, etc., are *enumeration members* (or *enum members*). @@ -474,7 +475,7 @@ Some rules: 4. %-style formatting: `%s` and `%r` call :class:`Enum`'s :meth:`__str__` and :meth:`__repr__` respectively; other codes (such as `%i` or `%h` for IntEnum) treat the enum member as its mixed-in type. -5. :class:`str`.:meth:`__format__` (or :func:`format`) will use the mixed-in +5. :meth:`str.__format__` (or :func:`format`) will use the mixed-in type's :meth:`__format__`. If the :class:`Enum`'s :func:`str` or :func:`repr` is desired use the `!s` or `!r` :class:`str` format codes. |