classification
Title: Formatting of True/False/None in docs
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.7, Python 3.6, Python 3.5, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Arfrever, docs@python, python-dev, serhiy.storchaka
Priority: normal Keywords: patch

Created on 2013-11-26 09:18 by serhiy.storchaka, last changed 2016-09-25 14:38 by serhiy.storchaka.

Files
File name Uploaded Description Edit
doc_truefalse.patch serhiy.storchaka, 2013-11-26 09:18 review
doc_none.patch serhiy.storchaka, 2013-11-29 10:46 review
doc_none2.patch serhiy.storchaka, 2016-09-25 14:38 review
Messages (7)
msg204463 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2013-11-26 09:18
The proposed patch improves formatting of True/False in the documentation. "True" becomes "``True``" if it means True constant and "true" if it means true value (in input arguments).

See also issue19793 and issue19794.
msg204712 - (view) Author: Roundup Robot (python-dev) Date: 2013-11-29 10:22
New changeset f51ca196d77a by Serhiy Storchaka in branch '2.7':
Issue #19795: Improved markup of True/False constants.
http://hg.python.org/cpython/rev/f51ca196d77a

New changeset b2066bc8cab9 by Serhiy Storchaka in branch '3.3':
Issue #19795: Improved markup of True/False constants.
http://hg.python.org/cpython/rev/b2066bc8cab9

New changeset 6a3e09cd96f3 by Serhiy Storchaka in branch 'default':
Issue #19795: Improved markup of True/False constants.
http://hg.python.org/cpython/rev/6a3e09cd96f3
msg204715 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2013-11-29 10:46
Thank you Georg for your help.

Here is a patch which fixes markups for the None constant. It is more unequivocal.
msg204756 - (view) Author: Arfrever Frehtes Taifersar Arahesis (Arfrever) * Date: 2013-11-29 21:26
> New changeset b2066bc8cab9 by Serhiy Storchaka in branch '3.3':
> Issue #19795: Improved markup of True/False constants.
> http://hg.python.org/cpython/rev/b2066bc8cab9

Accidental, unrelated changes in Doc/library/importlib.rst (and with conflict marker).
msg204758 - (view) Author: Roundup Robot (python-dev) Date: 2013-11-29 21:43
New changeset 9d0dc3d7bf01 by Serhiy Storchaka in branch '3.3':
Revert unrelated changes introduced by changeset b2066bc8cab9  (issue #19795).
http://hg.python.org/cpython/rev/9d0dc3d7bf01
msg204759 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2013-11-29 21:44
Thank you Arfrever.
msg277380 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2016-09-25 14:38
Only the first patch was committed. The patch for None is not reviewed yet.

Here is updated patch.
History
Date User Action Args
2016-09-25 14:38:47serhiy.storchakasetstatus: closed -> open
files: + doc_none2.patch

title: Formatting of True/False in docs -> Formatting of True/False/None in docs
resolution: fixed ->
versions: + Python 3.5, Python 3.6, Python 3.7, - Python 3.3, Python 3.4
messages: + msg277380
stage: resolved -> patch review
2016-09-25 13:13:42christian.heimessetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2013-11-29 21:44:19serhiy.storchakasetmessages: + msg204759
2013-11-29 21:43:22python-devsetmessages: + msg204758
2013-11-29 21:26:30Arfreversetnosy: + Arfrever
messages: + msg204756
2013-11-29 10:46:27serhiy.storchakasetfiles: + doc_none.patch

messages: + msg204715
2013-11-29 10:22:57python-devsetnosy: + python-dev
messages: + msg204712
2013-11-26 09:18:45serhiy.storchakacreate