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.

classification
Title: Document rules for use of case in section titles
Type: Stage: patch review
Components: Documentation Versions: Python 3.2
process
Status: closed Resolution:
Dependencies: Superseder:
Assigned To: belopolsky Nosy List: belopolsky, docs@python, eric.araujo
Priority: normal Keywords: patch

Created on 2010-11-11 15:05 by belopolsky, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
style-guide.diff belopolsky, 2010-11-11 15:05
issue10389.diff belopolsky, 2010-11-11 19:40
Messages (5)
msg120955 - (view) Author: Alexander Belopolsky (belopolsky) * (Python committer) Date: 2010-11-11 15:05
Following a brief and consensual discussion on docs@python and #python-dev, I am proposing attached patch for the Python documentation style guide.
msg120958 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-11-11 15:32
+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/.
msg120965 - (view) Author: Alexander Belopolsky (belopolsky) * (Python committer) Date: 2010-11-11 19:40
The new patch, issue10389.diff, addresses Éric's comments and adds an entry for "reST".
msg120972 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-11-11 21:36
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 ;)
msg120979 - (view) Author: Alexander Belopolsky (belopolsky) * (Python committer) Date: 2010-11-11 22:44
Committed in revision 86417.
History
Date User Action Args
2022-04-11 14:57:08adminsetgithub: 54598
2010-11-11 22:44:18belopolskysetstatus: open -> closed

messages: + msg120979
2010-11-11 21:36:12eric.araujosetmessages: + msg120972
2010-11-11 19:40:41belopolskysetfiles: + issue10389.diff

messages: + msg120965
2010-11-11 15:32:01eric.araujosetnosy: + docs@python, eric.araujo
messages: + msg120958
2010-11-11 15:05:54belopolskycreate