[docs] [issue21675] Library - Introduction - paragraph 5 - wrong ordering

Anthony Bartoli report at bugs.python.org
Fri Jun 6 05:30:32 CEST 2014


New submission from Anthony Bartoli:

>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.

----------
assignee: docs at python
components: Documentation
messages: 219860
nosy: AnthonyBartoli, docs at python
priority: normal
severity: normal
status: open
title: Library - Introduction - paragraph 5 - wrong ordering
type: enhancement
versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue21675>
_______________________________________


More information about the docs mailing list