]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] Docs: turn getopt examples into doctests (GH-126377) (#126386)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 4 Nov 2024 08:37:23 +0000 (09:37 +0100)
committerGitHub <noreply@github.com>
Mon, 4 Nov 2024 08:37:23 +0000 (08:37 +0000)
(cherry picked from commit 0d80777981f95bbc79b146fc78b2189c82521ab9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Doc/library/getopt.rst

index ef07ce9dd2c8669a08ed19e80bafe7a0a0604af6..13f1d9645964fd5d0a2437c9ae582d0a37c94cd6 100644 (file)
@@ -92,6 +92,8 @@ exception:
 
 An example using only Unix style options:
 
+.. doctest::
+
    >>> import getopt
    >>> args = '-a -b -cfoo -d bar a1 a2'.split()
    >>> args
@@ -104,6 +106,8 @@ An example using only Unix style options:
 
 Using long option names is equally easy:
 
+.. doctest::
+
    >>> s = '--condition=foo --testing --output-file abc.def -x a1 a2'
    >>> args = s.split()
    >>> args
@@ -115,7 +119,9 @@ Using long option names is equally easy:
    >>> args
    ['a1', 'a2']
 
-In a script, typical usage is something like this::
+In a script, typical usage is something like this:
+
+.. testcode::
 
    import getopt, sys
 
@@ -145,7 +151,9 @@ In a script, typical usage is something like this::
        main()
 
 Note that an equivalent command line interface could be produced with less code
-and more informative help and error messages by using the :mod:`argparse` module::
+and more informative help and error messages by using the :mod:`argparse` module:
+
+.. testcode::
 
    import argparse