[docs] [issue18628] PEP 8 and encodings
Terry J. Reedy
report at bugs.python.org
Fri Aug 2 06:49:44 CEST 2013
New submission from Terry J. Reedy:
Three related doc change proposals. The Versions only apply to the third as the first two are for PEP 8.
1. PEP 8 has a section entitled "Encodings (PEP 263)" with a link to the verbose PEP. I think it would be better if it were "Source Encoding" with a link to the 'current' Reference Manual section 2.1.4. Encoding declarations. The latter gets right to the point.
2. This section twice uses the informal and undefined term 'coding cookie'. It is not in the ref manual section above, nor in the glossary, nor in the index. (Dave Angel asked about the definition on python-list. Before searching on the web, he first thought it meant BOM.) I suggest changing "a coding cookie" to "an encoding declaration".
3. The index has several entries that begin with 'encode', including one that just says 'encodings'. The last is the one that points to 2.1.4., but one would only guess by process of elimination. I think 'encoding (source file)' or 'encoding declarations (source file)' would be clearer.
assignee: docs at python
nosy: docs at python, ncoghlan, terry.reedy
stage: needs patch
title: PEP 8 and encodings
versions: Python 2.7, Python 3.3, Python 3.4
Python tracker <report at bugs.python.org>
More information about the docs