diff options
author | Éric Araujo <merwok@netwok.org> | 2010-11-18 16:38:46 (GMT) |
---|---|---|
committer | Éric Araujo <merwok@netwok.org> | 2010-11-18 16:38:46 (GMT) |
commit | 713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5 (patch) | |
tree | 99bdc854fa7a540ee5339de5a2a6888bdc7d003e /Doc/library/webbrowser.rst | |
parent | daa29d01b749daa4843bcac80bd0067a827cfb8a (diff) | |
download | cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.zip cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.tar.gz cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.tar.bz2 |
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.
Diffstat (limited to 'Doc/library/webbrowser.rst')
-rw-r--r-- | Doc/library/webbrowser.rst | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index e8f4756..20c0913 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -31,8 +31,8 @@ browser and wait. The script :program:`webbrowser` can be used as a command-line interface for the module. It accepts an URL as the argument. It accepts the following optional -parameters: :option:`-n` opens the URL in a new browser window, if possible; -:option:`-t` opens the URL in a new browser page ("tab"). The options are, +parameters: ``-n`` opens the URL in a new browser window, if possible; +``-t`` opens the URL in a new browser page ("tab"). The options are, naturally, mutually exclusive. The following exception is defined: @@ -64,7 +64,6 @@ The following functions are defined: Open *url* in a new window of the default browser, if possible, otherwise, open *url* in the only browser window. - .. function:: open_new_tab(url) Open *url* in a new page ("tab") of the default browser, if possible, otherwise |