Message 182620 - Python tracker

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author	chris.jerdonek
Recipients	chris.jerdonek, eric.araujo, ezio.melotti, ncoghlan
Date	2013-02-22.02:18:02
SpamBayes Score	-1.0
Marked as misclassified	Yes
Message-id	<1361499483.55.0.95674710032.issue17270@psf.upfronthosting.co.za>
In-reply-to

Content
The documentation guidelines in the devguide list a convention for section headers: http://docs.python.org/devguide/documenting.html#sections The current wording, however, can be interpreted to mean that this convention is always (and should always) be used. However, the reality is weaker. For example, see: http://bugs.python.org/issue17109#msg181302 This issue is to update the wording so the convention is more clearly a suggestion rather than a requirement.

The documentation guidelines in the devguide list a convention for section headers:

http://docs.python.org/devguide/documenting.html#sections

The current wording, however, can be interpreted to mean that this convention is always (and should always) be used.  However, the reality is weaker.  For example, see:

http://bugs.python.org/issue17109#msg181302

This issue is to update the wording so the convention is more clearly a suggestion rather than a requirement.

History
Date	User	Action	Args
2013-02-22 02:18:03	chris.jerdonek	set	recipients: + chris.jerdonek, ncoghlan, ezio.melotti, eric.araujo
2013-02-22 02:18:03	chris.jerdonek	set	messageid: <1361499483.55.0.95674710032.issue17270@psf.upfronthosting.co.za>
2013-02-22 02:18:03	chris.jerdonek	link	issue17270 messages
2013-02-22 02:18:02	chris.jerdonek	create