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.

Title: make the section header doc convention more clearly optional
Type: enhancement Stage: resolved
Components: Devguide Versions:
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: chris.jerdonek, eric.araujo, ezio.melotti, ncoghlan, python-dev
Priority: normal Keywords: easy, patch

Created on 2013-02-22 02:18 by chris.jerdonek, last changed 2022-04-11 14:57 by admin. This issue is now closed.

File name Uploaded Description Edit
devguide-section-headers.diff chris.jerdonek, 2013-02-22 02:18
Messages (3)
msg182620 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2013-02-22 02:18
The documentation guidelines in the devguide list a convention for section headers:

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:

This issue is to update the wording so the convention is more clearly a suggestion rather than a requirement.
msg182621 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-02-22 02:19
msg182623 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-02-22 02:25
New changeset fa06f733e2fe by Chris Jerdonek in branch 'default':
Issue #17270: clarify that the section header doc convention is optional.
Date User Action Args
2022-04-11 14:57:42adminsetgithub: 61472
2013-02-22 02:27:01chris.jerdoneksetstatus: open -> closed
resolution: fixed
stage: commit review -> resolved
2013-02-22 02:25:27python-devsetnosy: + python-dev
messages: + msg182623
2013-02-22 02:19:11ezio.melottisetmessages: + msg182621
stage: patch review -> commit review
2013-02-22 02:18:03chris.jerdonekcreate