[New-bugs-announce] [issue17270] make the section header doc convention more clearly optional

[Chris Jerdonek]

New submission from Chris Jerdonek:

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.

----------
components: Devguide
files: devguide-section-headers.diff
keywords: easy, patch
messages: 182620
nosy: chris.jerdonek, eric.araujo, ezio.melotti, ncoghlan
priority: normal
severity: normal
stage: patch review
status: open
title: make the section header doc convention more clearly optional
type: enhancement
Added file: http://bugs.python.org/file29153/devguide-section-headers.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue17270>
_______________________________________