[Python-checkins] devguide: Issue #17270: clarify that the section header doc convention is optional.
chris.jerdonek
python-checkins at python.org
Fri Feb 22 03:25:27 CET 2013
http://hg.python.org/devguide/rev/fa06f733e2fe
changeset: 600:fa06f733e2fe
user: Chris Jerdonek <chris.jerdonek at gmail.com>
date: Thu Feb 21 18:23:47 2013 -0800
summary:
Issue #17270: clarify that the section header doc convention is optional.
files:
documenting.rst | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/documenting.rst b/documenting.rst
--- a/documenting.rst
+++ b/documenting.rst
@@ -419,7 +419,7 @@
Normally, there are no heading levels assigned to certain characters as the
structure is determined from the succession of headings. However, for the
-Python documentation, we use this convention:
+Python documentation, here is a suggested convention:
* ``#`` with overline, for parts
* ``*`` with overline, for chapters
--
Repository URL: http://hg.python.org/devguide
More information about the Python-checkins
mailing list