classification
Title: (docs) Consistent formatting of constants
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 2.7
process
Status: closed Resolution: duplicate
Dependencies: Superseder: fix True/False/None reST markup
View: 15580
Assigned To: docs@python Nosy List: chris.jerdonek, docs@python, ezio.melotti, zearin
Priority: normal Keywords: patch

Created on 2013-01-29 17:57 by zearin, last changed 2013-01-29 19:36 by ezio.melotti. This issue is now closed.

Files
File name Uploaded Description Edit
python_docs_constants.diff zearin, 2013-01-29 17:57 Patch fixing capitalization, markup for constants in ``Doc/library/``
Messages (6)
msg180918 - (view) Author: Zearin (zearin) Date: 2013-01-29 17:57
When reading the docs, I noticed that the capitalization and formatting of the Python constants ``True``, ``False``, and ``None`` were inconsistent.

The attached patch contains a fix for all such occurrences under ``/Doc/library/``.

(I **think** I correctly made the patch.  I hardly ever make patches, so if I screwed up, let me know and I’ll see if I can get it right. ☺)


Parent commit: 
9137e2d1c00c6906af206d1c9d217b15613bb1ed
msg180922 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2013-01-29 18:27
This has already been proposed in issue 15580.  By the way, you don't always want to replace "true" with ``True``.  The former has a different connotation/meaning which is boolean true rather than the object True.
msg180924 - (view) Author: Zearin (zearin) Date: 2013-01-29 18:34
Ah; I did look for dupes, but didn’t find it.  (So many issues…!)

Thanks for pointing me in the right direction.

> By the way, you don't always want to replace "true" with ``True``. 

The former has a different connotation/meaning which is boolean true =
rather than the object True.

Yes, I know.  I went through all the occurrences one by one, and I tried to take that into account.

*sigh* I guess it’s a moot point, now…

----

Got more to say on this subject, but I’ll do it in other issue.  Take care!
msg180929 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2013-01-29 18:54
> Yes, I know.  I went through all the occurrences one by one, and I tried to take that into account.

See issue 4945 for a discussion like this.  Might be relevant to what you have in mind.
msg180931 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2013-01-29 19:02
> This has already been proposed in issue 15580.

By the way, I should have said "something along the same lines."  Issue 15580 is about eliminating uses of :const:`None`, etc, whereas this targets a different case.  But it is similar in scope so the same discussion/reasons apply.
msg180932 - (view) Author: Zearin (zearin) Date: 2013-01-29 19:04
> By the way, I should have said "something along the same lines."  Issue 15580 is about eliminating uses of :const:`None`, etc, whereas this targets a different case.  But it is similar in scope so the same discussion/reasons apply.

Yep!  I read, and understood the difference.  

I still had 2¢ to add.  I’m kind of a nut for good documentation. ;)
History
Date User Action Args
2013-01-29 19:36:41ezio.melottisetnosy: + ezio.melotti
2013-01-29 19:04:21zearinsetmessages: + msg180932
2013-01-29 19:02:29chris.jerdoneksetmessages: + msg180931
2013-01-29 18:54:39chris.jerdoneksetmessages: + msg180929
2013-01-29 18:34:53zearinsetmessages: + msg180924
2013-01-29 18:27:56chris.jerdoneksetstatus: open -> closed

superseder: fix True/False/None reST markup

nosy: + chris.jerdonek
messages: + msg180922
resolution: duplicate
stage: resolved
2013-01-29 17:58:57zearinsettype: enhancement
2013-01-29 17:57:49zearincreate