[issue34116] Move all bytes/bytearray/int/float/complex documentation to Built-in Types
New submission from Andrés Delfino <adelfino@gmail.com>: Right now, bytearray, bytes, complex, float and int documentation is splitted into stdtypes.rst and functions.rst. I think stdtypes.rst should be the only source with all documentation, and functions.rst should just point out to stdtypes.rst. This would make it easier to get the complete picture of a given type without having to jump between pages. This is how the documentation of dict, frozenset, list, memoryview, range, set, str and tuple works. I believe bool() is more useful in functions.rst, as it's really short. ---------- assignee: docs@python components: Documentation messages: 321667 nosy: adelfino, docs@python priority: normal severity: normal status: open title: Move all bytes/bytearray/int/float/complex documentation to Built-in Types type: enhancement versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34116> _______________________________________
Change by Andrés Delfino <adelfino@gmail.com>: ---------- keywords: +patch pull_requests: +7820 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34116> _______________________________________
Andrés Delfino <adelfino@gmail.com> added the comment: See talk at: https://python.zulipchat.com/#narrow/stream/116633-documentation/subject/Gat... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34116> _______________________________________
Raymond Hettinger <raymond.hettinger@gmail.com> added the comment: I disagree that this would be an improvement. The current organization has worked well for us. In particular, some of the these types sometimes used like functions that produce a type (this is where the builtin functions docs do a good job). In the stdtypes docs, we go into detail about what the types do and have them grouped in a way that can be compared and contrasted. As a Python instructor, I ask newcomers to read the built-in functions section because it tells them a lot of what they need to know to get up and running with the language (indeed, that is why these are all builitins rather than relegated to modules). The stdtypes section is more voluminous and rarely read start to finish (mostly just used as a reference). ---------- nosy: +rhettinger resolution: -> rejected stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue34116> _______________________________________
participants (2)
-
Andrés Delfino -
Raymond Hettinger