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: Warnings in Doc/library/json.rst
Type: Stage: resolved
Components: Documentation Versions: Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Arfrever, benjamin.peterson, berker.peksag, docs@python, python-dev
Priority: normal Keywords: patch

Created on 2014-04-13 10:19 by Arfrever, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue21210.diff berker.peksag, 2014-04-13 10:43 review
Messages (3)
msg216012 - (view) Author: Arfrever Frehtes Taifersar Arahesis (Arfrever) * (Python triager) Date: 2014-04-13 10:19
Warnings during building of documentation (with Sphinx 1.2.2):

${cpython_working_copy}/Doc/library/json.rst:593: WARNING: Malformed option description '[<infile>]', should look like "opt", "-opt args", "--opt args" or "/opt args"
${cpython_working_copy}/Doc/library/json.rst:609: WARNING: Malformed option description '[<outfile>]', should look like "opt", "-opt args", "--opt args" or "/opt args"


Probably introduced by:

New changeset a2ad16e86e60 by Benjamin Peterson in branch 'default':
improve the command-line interface of json.tool (closes #21000)
http://hg.python.org/cpython/rev/a2ad16e86e60
msg216014 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2014-04-13 10:43
Thanks for the report Arfrever. Here's a patch to silence the warnings.
msg216039 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-04-13 23:52
New changeset 399bf1638911 by Benjamin Peterson in branch 'default':
correct sphinx mark up for cmdline options (closes #21210)
http://hg.python.org/cpython/rev/399bf1638911
History
Date User Action Args
2022-04-11 14:58:01adminsetgithub: 65409
2014-04-13 23:52:25python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg216039

resolution: fixed
stage: resolved
2014-04-13 10:43:18berker.peksagsetfiles: + issue21210.diff
keywords: + patch
messages: + msg216014
2014-04-13 10:19:27Arfrevercreate