[issue29666] Issue in enum documentation
New submission from STINNER Victor: https://docs.python.org/dev/library/enum.html "This module defines four enumeration classes that can be used to define unique sets of names and values: Enum, IntEnum, and IntFlags" Enum, IntEnum, IntFlag: I count 3 classes, no 4? Moreover, the correct class name is IntFlag, not IntFlags. Or did I miss something? haypo@selma$ ./python Python 3.7.0a0 (default, Feb 25 2017, 04:30:32)
---------- assignee: docs@python components: Documentation keywords: easy messages: 288642 nosy: docs@python, haypo priority: normal severity: normal status: open title: Issue in enum documentation versions: Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Jim Fasarakis-Hilliard added the comment: Yup, `IntFlags` is a typo, that's why the reference to it doesn't show too. Also, the fourth enum must be `Flag` which must of been omitted when it was added in `3.6`. ---------- nosy: +Jim Fasarakis-Hilliard _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Ethan Furman added the comment: `Flag` and `IntFlag` are indeed the correct (and missing) names. ---------- nosy: +ethan.furman _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Kartik added the comment: Hi I've edited the documentation to correct this and submitted a PR. ---------- nosy: +exqu17 pull_requests: +305 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Changes by STINNER Victor <victor.stinner@gmail.com>: ---------- versions: +Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Changes by STINNER Victor <victor.stinner@gmail.com>: ---------- pull_requests: +325 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
STINNER Victor added the comment: Doc has been fixed in Python 3.6 and 3.7. Thanks! ---------- resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Jim Fasarakis-Hilliard added the comment: Yup, `IntFlags` is a typo, that's why the reference to it doesn't show too. Also, the fourth enum must be `Flag` which must of been omitted when it was added in `3.6`. ---------- nosy: +Jim Fasarakis-Hilliard _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Ethan Furman added the comment: `Flag` and `IntFlag` are indeed the correct (and missing) names. ---------- nosy: +ethan.furman _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Kartik added the comment: Hi I've edited the documentation to correct this and submitted a PR. ---------- nosy: +exqu17 pull_requests: +305 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Changes by STINNER Victor <victor.stinner@gmail.com>: ---------- versions: +Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
Changes by STINNER Victor <victor.stinner@gmail.com>: ---------- pull_requests: +325 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
STINNER Victor added the comment: Doc has been fixed in Python 3.6 and 3.7. Thanks! ---------- resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue29666> _______________________________________
participants (4)
-
Ethan Furman -
Jim Fasarakis-Hilliard
-
Kartik
-
STINNER Victor