Author eli.bendersky
Recipients docs@python, eli.bendersky
Date 2010-07-20.04:19:45
SpamBayes Score 0.000501374
Marked as misclassified No
Message-id <1279599587.56.0.337150515932.issue9312@psf.upfronthosting.co.za>
In-reply-to
Content
Due to a discussion on python-dev (Subject: "Markup of command-line options in Python's .rst documentation"), Georg Brandl checked in revision r82961 with a clarification of :option: markup which should only be used for Python interpreter's own flags.

However, several modules in stdlib use :option: for their own command-line options, which creates confusion (these options get linked by Sphinx to unrelated Python options).

I'm attaching a patch that fixes this issue for these files. The affected files are:

Doc/library/idle.rst
Doc/library/timeit.rst
Doc/library/test.rst
Doc/library/doctest.rst
Doc/library/unittest.rst
Doc/library/pydoc.rst
Doc/library/webbrowser.rst
Doc/library/compileall.rst

Note1: :option: was fixed to `` markup (code snippet) as per the recommendation in the updated documentation guide
Note2: I didn't patch trace.rst because it's overgoing a major rehaul (http://bugs.python.org/issue9264)
History
Date User Action Args
2010-07-20 04:19:47eli.benderskysetrecipients: + eli.bendersky, docs@python
2010-07-20 04:19:47eli.benderskysetmessageid: <1279599587.56.0.337150515932.issue9312@psf.upfronthosting.co.za>
2010-07-20 04:19:45eli.benderskylinkissue9312 messages
2010-07-20 04:19:45eli.benderskycreate