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/idle.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/idle.rst')
-rw-r--r-- | Doc/library/idle.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst index 1b78fb9..6bd1898 100644 --- a/Doc/library/idle.rst +++ b/Doc/library/idle.rst @@ -286,13 +286,13 @@ Command line usage If there are arguments: -#. If :option:`-e` is used, arguments are files opened for editing and +#. If ``-e`` is used, arguments are files opened for editing and ``sys.argv`` reflects the arguments passed to IDLE itself. -#. Otherwise, if :option:`-c` is used, all arguments are placed in +#. Otherwise, if ``-c`` is used, all arguments are placed in ``sys.argv[1:...]``, with ``sys.argv[0]`` set to ``'-c'``. -#. Otherwise, if neither :option:`-e` nor :option:`-c` is used, the first +#. Otherwise, if neither ``-e`` nor ``-c`` is used, the first argument is a script which is executed with the remaining arguments in ``sys.argv[1:...]`` and ``sys.argv[0]`` set to the script name. If the script name is '-', no script is executed but an interactive Python session is started; |