[Python-checkins] devguide: Fix-up grammar and remove last reference to the Apple style guide.
georg.brandl
python-checkins at python.org
Sun Oct 6 12:21:21 CEST 2013
http://hg.python.org/devguide/rev/937e3d3eb043
changeset: 643:937e3d3eb043
user: Georg Brandl <georg at python.org>
date: Sun Oct 06 12:22:09 2013 +0200
summary:
Fix-up grammar and remove last reference to the Apple style guide.
files:
documenting.rst | 13 ++++---------
1 files changed, 4 insertions(+), 9 deletions(-)
diff --git a/documenting.rst b/documenting.rst
--- a/documenting.rst
+++ b/documenting.rst
@@ -101,19 +101,14 @@
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 greatly between publications.
-
-In Python documentation, use of sentence case in section titles is
+In the Python documentation, the 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
+following this rule. If you add a section to a 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
-elsewhere.
+starting it with a lower case letter should be avoided.
.. note::
--
Repository URL: http://hg.python.org/devguide
More information about the Python-checkins
mailing list