]> granicus.if.org Git - python/commit
Fix usage of :option: in the docs (#9312).
authorÉric Araujo <merwok@netwok.org>
Thu, 18 Nov 2010 16:38:46 +0000 (16:38 +0000)
committerÉric Araujo <merwok@netwok.org>
Thu, 18 Nov 2010 16:38:46 +0000 (16:38 +0000)
commit713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5
tree99bdc854fa7a540ee5339de5a2a6888bdc7d003e
parentdaa29d01b749daa4843bcac80bd0067a827cfb8a
Fix usage of :option: in the docs (#9312).

:option: is used to create a link to an option of python, not to mark
up any instance of any arbitrary command-line option.  These were
changed to ````.

For modules which do have a command-line interface, lists of options
have been properly marked up with the program/cmdoption directives
combo.  Options defined in such blocks can be linked to with :option:
later in the same file, they won’t link to an option of python.

Finally, the markup of command-line fragments in optparse.rst has
been cleaned to use ``x`` instead of ``"x"``, keeping that latter
form for actual Python strings.

Patch by Eli Bendersky and Éric Araujo.
13 files changed:
Doc/library/codecs.rst
Doc/library/compileall.rst
Doc/library/doctest.rst
Doc/library/exceptions.rst
Doc/library/getopt.rst
Doc/library/idle.rst
Doc/library/optparse.rst
Doc/library/pydoc.rst
Doc/library/sys.rst
Doc/library/test.rst
Doc/library/timeit.rst
Doc/library/unittest.rst
Doc/library/webbrowser.rst