[Python-checkins] r86417 - python/branches/py3k/Doc/documenting/style.rst
python-checkins at python.org
Thu Nov 11 23:43:45 CET 2010
Date: Thu Nov 11 23:43:45 2010
New Revision: 86417
Issue #10389: Documented rules for use of case in section titles.
--- python/branches/py3k/Doc/documenting/style.rst (original)
+++ python/branches/py3k/Doc/documenting/style.rst Thu Nov 11 23:43:45 2010
@@ -1,14 +1,18 @@
.. highlightlang:: rest
The Python documentation should follow the `Apple Publications Style Guide`_
wherever possible. This particular style guide was selected mostly because it
seems reasonable and is easy to get online.
-Topics which are not covered in Apple's style guide will be discussed in
+Topics which are either not covered in Apple's style guide or treated
+differently in Python documentation will be discussed in this
+Use of whitespace
All reST files use an indentation of 3 spaces. The maximum line length is 80
characters for normal text, but tables, deeply indented code samples and long
@@ -21,6 +25,9 @@
ignores the second space, it is customarily put in by some users, for example
to aid Emacs' auto-fill mode.
Footnotes are generally discouraged, though they may be used when they are the
best way to present specific information. When a footnote reference is added at
the end of the sentence, it should follow the sentence-ending punctuation. The
@@ -34,6 +41,36 @@
Footnotes may appear in the middle of sentences where appropriate.
+.. sidebar:: Sentence case
+ Sentence case is a set of capitalization rules used in English
+ sentences: the first word is always capitalized and other words are
+ only capitalized if there is a specific rule requiring it.
+Apple style guide recommends the use of title case in section titles.
+However, rules for which words should be capitalized in title case
+vary greaty between publications.
+In Python documentation, use of sentence case in section titles is
+preferable, but consistency within a unit is more important than
+following this rule. If you add a section to the chapter where most
+sections are in title case you can either convert all titles to
+sentence case or use the dominant style in the new section title.
+Sentences that start with a word for which specific rules require
+starting it with a lower case letter should be avoided in titles and
+ Sections that describe a library module often have titles in the
+ form of "modulename --- Short description of the module." In this
+ case, the description should be capitalized as a stand-alone
Many special names are used in the Python documentation, including the names of
operating systems, programming languages, standards bodies, and the like. Most
of these entities are not assigned any special markup, but the preferred
@@ -44,26 +81,32 @@
be used to ensure consistency throughout the documentation:
- For "central processing unit." Many style guides say this should be spelled
- out on the first use (and if you must use it, do so!). For the Python
- documentation, this abbreviation should be avoided since there's no
- reasonable way to predict which occurrence will be the first seen by the
- reader. It is better to use the word "processor" instead.
+ For "central processing unit." Many style guides say this should be
+ spelled out on the first use (and if you must use it, do so!). For
+ the Python documentation, this abbreviation should be avoided since
+ there's no reasonable way to predict which occurrence will be the
+ first seen by the reader. It is better to use the word "processor"
- The name assigned to a particular group of standards. This is always
+ The name assigned to a particular group of standards. This is always
- The name of our favorite programming language is always capitalized.
+ The name of our favorite programming language is always capitalized.
+ For "reStructuredText," an easy to read, plaintext markup syntax
+ used to produce Python documentation. When spelled out, it is
+ always one word and both forms start with a lower case 'r'.
- The name of a character set and matching encoding. This is always written
+ The name of a character coding system. This is always written
- The name of the operating system developed at AT&T Bell Labs in the early
+ The name of the operating system developed at AT&T Bell Labs in the early
.. _Apple Publications Style Guide: http://developer.apple.com/mac/library/documentation/UserExperience/Conceptual/APStyleGuide/APSG_2009.pdf
More information about the Python-checkins