classification
Title: Library - Introduction - paragraph 5 - wrong ordering
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: AnthonyBartoli, docs@python, python-dev
Priority: normal Keywords:

Created on 2014-06-06 03:30 by AnthonyBartoli, last changed 2014-10-11 13:08 by python-dev. This issue is now closed.

Messages (2)
msg219860 - (view) Author: Anthony Bartoli (AnthonyBartoli) Date: 2014-06-06 03:30
From the library's introduction page:

"This manual is organized “from the inside out:” it first describes the built-in data types..."

The library manual first describes built-in functions, not data types. 

After built-in functions, it describes built-in constants, built-in types, and built-in exceptions. Lastly, it describes modules grouped by related functionality. 

A suggested re-write *for the entire paragraph*:

"The library manual first documents built-in functions, built-in constants, built-in types, and built-in exceptions. Then it documents modules grouped by related functionality. 

I suggest eliminating the last sentence:

"The ordering of the chapters as well as the ordering of the modules within each chapter is roughly from most relevant to least important."

Importance is subjective and parts of the manual are organized alphabetically, not by relevance / importance.
msg229087 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-10-11 13:08
New changeset 52b9d79f6bfa by Georg Brandl in branch '3.4':
Closes #21675: fix ordering of description in library intro
https://hg.python.org/cpython/rev/52b9d79f6bfa
History
Date User Action Args
2014-10-11 13:08:29python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg229087

resolution: fixed
stage: resolved
2014-06-06 03:30:32AnthonyBartolicreate