[issue19795] Formatting of True/False in docs
New submission from Serhiy Storchaka: 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. ---------- assignee: docs@python components: Documentation files: doc_truefalse.patch keywords: patch messages: 204463 nosy: docs@python, serhiy.storchaka priority: normal severity: normal stage: patch review status: open title: Formatting of True/False in docs type: enhancement versions: Python 2.7, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file32854/doc_truefalse.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Roundup Robot added the comment: 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 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Serhiy Storchaka added the comment: Thank you Georg for your help. Here is a patch which fixes markups for the None constant. It is more unequivocal. ---------- Added file: http://bugs.python.org/file32885/doc_none.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Arfrever Frehtes Taifersar Arahesis added the comment:
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). ---------- nosy: +Arfrever _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Roundup Robot added the comment: 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 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Serhiy Storchaka added the comment: Thank you Arfrever. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Changes by Christian Heimes <lists@cheimes.de>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Serhiy Storchaka added the comment: Only the first patch was committed. The patch for None is not reviewed yet. Here is updated patch. ---------- resolution: fixed -> stage: resolved -> patch review status: closed -> open title: Formatting of True/False in docs -> Formatting of True/False/None in docs versions: +Python 3.5, Python 3.6, Python 3.7 -Python 3.3, Python 3.4 Added file: http://bugs.python.org/file44821/doc_none2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: Added file: http://bugs.python.org/file45130/doc_none3-3.6.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: Added file: http://bugs.python.org/file45131/doc_none3-3.5.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Roundup Robot added the comment: New changeset cef2373f31bb by Serhiy Storchaka in branch '2.7': Issue #19795: Mark up None as literal text. https://hg.python.org/cpython/rev/cef2373f31bb New changeset a8d5b433bb36 by Serhiy Storchaka in branch '3.5': Issue #19795: Mark up None as literal text. https://hg.python.org/cpython/rev/a8d5b433bb36 New changeset 2e97ed8e7e3c by Serhiy Storchaka in branch '3.6': Issue #19795: Mark up None as literal text. https://hg.python.org/cpython/rev/2e97ed8e7e3c New changeset 5f997b3cb59c by Serhiy Storchaka in branch 'default': Issue #19795: Mark up None as literal text. https://hg.python.org/cpython/rev/5f997b3cb59c New changeset b7df6c09ddf9 by Serhiy Storchaka in branch '2.7': Issue #19795: Mark up True and False as literal text instead of bold. https://hg.python.org/cpython/rev/b7df6c09ddf9 New changeset 477a82ec81fc by Serhiy Storchaka in branch '3.5': Issue #19795: Mark up True and False as literal text instead of bold. https://hg.python.org/cpython/rev/477a82ec81fc New changeset 91992ea3c6b1 by Serhiy Storchaka in branch '3.6': Issue #19795: Mark up True and False as literal text instead of bold. https://hg.python.org/cpython/rev/91992ea3c6b1 New changeset 8cc9ad294ea9 by Serhiy Storchaka in branch 'default': Issue #19795: Mark up True and False as literal text instead of bold. https://hg.python.org/cpython/rev/8cc9ad294ea9 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
STINNER Victor added the comment: The "Docs" bot doesn't like your change: http://buildbot.python.org/all/builders/Docs%203.x/builds/2673/steps/suspici... WARNING: [whatsnew/3.1:549] "`" found in "``False``" WARNING: [whatsnew/3.4:163] "`" found in "to ``None`" WARNING: [whatsnew/3.4:163] "`" found in " during finalization <whatsnew-pep-442>` (" /buildbot/buildarea/3.x.ware-docs/build/Doc/whatsnew/3.4.rst:163: WARNING: undefined label: module globals are no longer set to ``none` (if the link has no caption the label must precede a section header) Extract of the change: - protocol 3. Another solution is to set the *fix_imports* option to **False**. + protocol 3. Another solution is to set the *fix_imports* option to *``False``*. I guess that it should ``False`` without star? ---------- nosy: +haypo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Roundup Robot added the comment: New changeset 9ef78351d2e9 by Serhiy Storchaka in branch '3.5': Issue #19795: Fixed markup errors. https://hg.python.org/cpython/rev/9ef78351d2e9 New changeset 6c8a26e60728 by Serhiy Storchaka in branch '3.6': Issue #19795: Fixed markup errors. https://hg.python.org/cpython/rev/6c8a26e60728 New changeset 2127ef3b7660 by Serhiy Storchaka in branch 'default': Issue #19795: Fixed markup errors. https://hg.python.org/cpython/rev/2127ef3b7660 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Fred L. Drake, Jr. added the comment: Without the star would be right. ReST does not support nested markup, and in this case, I don't think it would make sense anyway. ---------- nosy: +fdrake _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
STINNER Victor added the comment: Thanks, "build #1563 of Docs 3.5 is complete: Success [build successful]": the bot is happy again ;-) ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Roundup Robot added the comment: New changeset e4aa34a7ca53 by Serhiy Storchaka in branch '3.5': Issue #19795: Improved more markups of True/False. https://hg.python.org/cpython/rev/e4aa34a7ca53 New changeset dd7e48e3e5b0 by Serhiy Storchaka in branch '2.7': Issue #19795: Improved more markups of True/False. https://hg.python.org/cpython/rev/dd7e48e3e5b0 New changeset 7b143d6834cf by Serhiy Storchaka in branch '3.6': Issue #19795: Improved more markups of True/False. https://hg.python.org/cpython/rev/7b143d6834cf New changeset 9fc0f20ea7de by Serhiy Storchaka in branch 'default': Issue #19795: Improved more markups of True/False. https://hg.python.org/cpython/rev/9fc0f20ea7de ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Serhiy Storchaka added the comment: Thank you for noticing this Victor. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Zachary Ware added the comment: There's also an issue with a table in Doc/library/logging.rst, see http://buildbot.python.org/all/builders/Docs%203.x/builds/2675/steps/docbuil... I'm not sure why that doesn't cause the build to fail, though, it's marked as an error. ---------- nosy: +zach.ware _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Roundup Robot added the comment: New changeset c445746d0846 by Serhiy Storchaka in branch '3.5': Issue #19795: Fixed formatting a table. https://hg.python.org/cpython/rev/c445746d0846 New changeset 3b554c9ea1c4 by Serhiy Storchaka in branch '3.6': Issue #19795: Fixed formatting a table. https://hg.python.org/cpython/rev/3b554c9ea1c4 New changeset 884c9d9159dc by Serhiy Storchaka in branch 'default': Issue #19795: Fixed formatting a table. https://hg.python.org/cpython/rev/884c9d9159dc New changeset ddf32a646457 by Serhiy Storchaka in branch '2.7': Issue #19795: Fixed formatting a table. https://hg.python.org/cpython/rev/ddf32a646457 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Serhiy Storchaka added the comment: Thanks Zachary. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue19795> _______________________________________
participants (7)
-
Arfrever Frehtes Taifersar Arahesis -
Christian Heimes
-
Fred L. Drake, Jr.
-
Roundup Robot
-
Serhiy Storchaka
-
STINNER Victor
-
Zachary Ware