Skip to content

Commit fc545db

Browse files
committed
Fix Sphinx warnings
1 parent 8bc019a commit fc545db

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Doc/library/getopt.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@
1414
.. note::
1515

1616
The :mod:`getopt` module is a parser for command line options whose API is
17-
designed to be familiar to users of the C :c:func:`getopt` function. Users who
18-
are unfamiliar with the C :c:func:`getopt` function or who would like to write
17+
designed to be familiar to users of the C :c:func:`!getopt` function. Users who
18+
are unfamiliar with the C :c:func:`!getopt` function or who would like to write
1919
less code and get better help and error messages should consider using the
2020
:mod:`argparse` module instead.
2121

2222
--------------
2323

2424
This module helps scripts to parse the command line arguments in ``sys.argv``.
25-
It supports the same conventions as the Unix :c:func:`getopt` function (including
25+
It supports the same conventions as the Unix :c:func:`!getopt` function (including
2626
the special meanings of arguments of the form '``-``' and '``--``'). Long
2727
options similar to those supported by GNU software may be used as well via an
2828
optional third argument.
@@ -37,11 +37,11 @@ exception:
3737
be parsed, without the leading reference to the running program. Typically, this
3838
means ``sys.argv[1:]``. *shortopts* is the string of option letters that the
3939
script wants to recognize, with options that require an argument followed by a
40-
colon (``':'``; i.e., the same format that Unix :c:func:`getopt` uses).
40+
colon (``':'``; i.e., the same format that Unix :c:func:`!getopt` uses).
4141

4242
.. note::
4343

44-
Unlike GNU :c:func:`getopt`, after a non-option argument, all further
44+
Unlike GNU :c:func:`!getopt`, after a non-option argument, all further
4545
arguments are considered also non-options. This is similar to the way
4646
non-GNU Unix systems work.
4747

@@ -75,7 +75,7 @@ exception:
7575
non-option argument is encountered.
7676

7777
If the first character of the option string is ``'+'``, or if the environment
78-
variable :envvar:`POSIXLY_CORRECT` is set, then option processing stops as
78+
variable :envvar:`!POSIXLY_CORRECT` is set, then option processing stops as
7979
soon as a non-option argument is encountered.
8080

8181

@@ -85,9 +85,9 @@ exception:
8585
an option requiring an argument is given none. The argument to the exception is
8686
a string indicating the cause of the error. For long options, an argument given
8787
to an option which does not require one will also cause this exception to be
88-
raised. The attributes :attr:`msg` and :attr:`opt` give the error message and
88+
raised. The attributes :attr:`!msg` and :attr:`!opt` give the error message and
8989
related option; if there is no specific option to which the exception relates,
90-
:attr:`opt` is an empty string.
90+
:attr:`!opt` is an empty string.
9191

9292
.. XXX deprecated?
9393
.. exception:: error

0 commit comments

Comments
 (0)