classification
Title: Move all bytes/bytearray/int/float/complex documentation to Built-in Types
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7, Python 3.6, Python 2.7
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: docs@python Nosy List: adelfino, docs@python, rhettinger
Priority: normal Keywords: patch

Created on 2018-07-15 00:07 by adelfino, last changed 2018-07-16 09:53 by rhettinger. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 8286 closed adelfino, 2018-07-15 00:22
Messages (3)
msg321667 - (view) Author: Andrés Delfino (adelfino) * (Python triager) Date: 2018-07-15 00:07
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.
msg321669 - (view) Author: Andrés Delfino (adelfino) * (Python triager) Date: 2018-07-15 00:24
See talk at: https://python.zulipchat.com/#narrow/stream/116633-documentation/subject/Gather.20all.20type.20documentation.20in.20stdtypes
msg321728 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2018-07-16 09:53
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).
History
Date User Action Args
2018-07-16 09:53:26rhettingersetstatus: open -> closed

nosy: + rhettinger
messages: + msg321728

resolution: rejected
stage: patch review -> resolved
2018-07-15 00:24:23adelfinosetmessages: + msg321669
2018-07-15 00:22:45adelfinosetkeywords: + patch
stage: patch review
pull_requests: + pull_request7820
2018-07-15 00:07:30adelfinocreate