Document rules for use of case in section titles

[abalkin]

BPO	10389
Nosy	@abalkin, @merwok
Files	style-guide.diff issue10389.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/abalkin'
closed_at = <Date 2010-11-11.22:44:18.026>
created_at = <Date 2010-11-11.15:05:54.593>
labels = ['docs']
title = 'Document rules for use of case in section titles'
updated_at = <Date 2010-11-11.22:44:18.024>
user = 'https://github.com/abalkin'

bugs.python.org fields:

activity = <Date 2010-11-11.22:44:18.024>
actor = 'belopolsky'
assignee = 'belopolsky'
closed = True
closed_date = <Date 2010-11-11.22:44:18.026>
closer = 'belopolsky'
components = ['Documentation']
creation = <Date 2010-11-11.15:05:54.593>
creator = 'belopolsky'
dependencies = []
files = ['19570', '19571']
hgrepos = []
issue_num = 10389
keywords = ['patch']
message_count = 5.0
messages = ['120955', '120958', '120965', '120972', '120979']
nosy_count = 3.0
nosy_names = ['belopolsky', 'eric.araujo', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue10389'
versions = ['Python 3.2']

[abalkin]

Following a brief and consensual discussion on docs@python and #python-dev, I am proposing attached patch for the Python documentation style guide.

[merwok]

+1 about the patch, if you add an example: “sentence case” may not be obvious for everyone. If it’s “modulename — Module description”, I agree.

Also, s/white space/whitespace/.

[abalkin]

The new patch, bpo-10389.diff, addresses Éric's comments and adds an entry for "reST".

[merwok]

Looks good. I wouldn’t say reST is WYSIWYG, since it’s transformed, contrary to word processors where you make text bold to get it bold.

(If you’re looking for other things to fix in that file, look at the entry for Unicode ;)

[abalkin]

Committed in revision 86417.