mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Migrate to Sphinx 1.0 C language constructs.

Browse source
This commit is contained in:
Georg Brandl 2010-10-06 10:11:56 +00:00
parent 64a41edb03
commit 60203b41b0
106 changed files with 2573 additions and 2569 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/getopt.rst
View file

@ -7,13 +7,13 @@
.. note::
The :mod:`getopt` module is a parser for command line options whose API is
designed to be familiar to users of the C :cfunc:`getopt` function. Users who
are unfamiliar with the C :cfunc:`getopt` function or who would like to write
designed to be familiar to users of the C :c:func:`getopt` function. Users who
are unfamiliar with the C :c:func:`getopt` function or who would like to write
less code and get better help and error messages should consider using the
:mod:`argparse` module instead.
This module helps scripts to parse the command line arguments in ``sys.argv``.
It supports the same conventions as the Unix :cfunc:`getopt` function (including
It supports the same conventions as the Unix :c:func:`getopt` function (including
the special meanings of arguments of the form '``-``' and '``--``'). Long
options similar to those supported by GNU software may be used as well via an
optional third argument.
@ -31,11 +31,11 @@ exception:
be parsed, without the leading reference to the running program. Typically, this
means ``sys.argv[1:]``. *shortopts* is the string of option letters that the
script wants to recognize, with options that require an argument followed by a
colon (``':'``; i.e., the same format that Unix :cfunc:`getopt` uses).
colon (``':'``; i.e., the same format that Unix :c:func:`getopt` uses).
.. note::
Unlike GNU :cfunc:`getopt`, after a non-option argument, all further
Unlike GNU :c:func:`getopt`, after a non-option argument, all further
arguments are considered also non-options. This is similar to the way
non-GNU Unix systems work.