Merged revisions 86521,86632,86823-86824,87294,87296,87300,87302 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86521 | eric.araujo | 2010-11-18 17:38:46 +0100 (jeu., 18 nov. 2010) | 17 lines
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.
........
r86632 | eric.araujo | 2010-11-21 04:09:17 +0100 (dim., 21 nov. 2010) | 2 lines
Style edits in followup to r86521 (#9312)
........
r86823 | eric.araujo | 2010-11-27 00:31:07 +0100 (sam., 27 nov. 2010) | 2 lines
Use link-generating markup (see #9312)
........
r86824 | eric.araujo | 2010-11-27 00:46:18 +0100 (sam., 27 nov. 2010) | 2 lines
Rewrap long lines + minor edits
........
r87294 | eric.araujo | 2010-12-16 01:07:01 +0100 (jeu., 16 déc. 2010) | 2 lines
No need to generate a link for something that’s just above.
........
r87296 | eric.araujo | 2010-12-16 01:23:30 +0100 (jeu., 16 déc. 2010) | 2 lines
Advertise “python -m” instead of direct filename.
........
r87300 | eric.araujo | 2010-12-16 02:40:26 +0100 (jeu., 16 déc. 2010) | 2 lines
Advertise “python -m test” over test.regrtest (r87296 followup)
........
r87302 | eric.araujo | 2010-12-16 03:10:11 +0100 (jeu., 16 déc. 2010) | 2 lines
Add versionadded directive missing from r78983.
........
diff --git a/Doc/library/getopt.rst b/Doc/library/getopt.rst
index 3114a82..4d65c79 100644
--- a/Doc/library/getopt.rst
+++ b/Doc/library/getopt.rst
@@ -41,14 +41,14 @@
non-GNU Unix systems work.
*long_options*, if specified, must be a list of strings with the names of the
- long options which should be supported. The leading ``'-``\ ``-'``
+ long options which should be supported. The leading ``'--'``
characters should not be included in the option name. Long options which
require an argument should be followed by an equal sign (``'='``). Optional
arguments are not supported. To accept only long options, *options* should
be an empty string. Long options on the command line can be recognized so
long as they provide a prefix of the option name that matches exactly one of
the accepted options. For example, if *long_options* is ``['foo', 'frob']``,
- the option :option:`--fo` will match as :option:`--foo`, but :option:`--f`
+ the option ``--fo`` will match as ``--foo``, but ``--f``
will not match uniquely, so :exc:`GetoptError` will be raised.
The return value consists of two elements: the first is a list of ``(option,
@@ -56,7 +56,7 @@
option list was stripped (this is a trailing slice of *args*). Each
option-and-value pair returned has the option as its first element, prefixed
with a hyphen for short options (e.g., ``'-x'``) or two hyphens for long
- options (e.g., ``'-``\ ``-long-option'``), and the option argument as its
+ options (e.g., ``'--long-option'``), and the option argument as its
second element, or an empty string if the option has no argument. The
options occur in the list in the same order in which they were found, thus
allowing multiple occurrences. Long and short options may be mixed.
@@ -69,7 +69,7 @@
intermixed. The :func:`getopt` function stops processing options as soon as a
non-option argument is encountered.
- If the first character of the option string is '+', or if the environment
+ If the first character of the option string is ``'+'``, or if the environment
variable :envvar:`POSIXLY_CORRECT` is set, then option processing stops as
soon as a non-option argument is encountered.