]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Update argparse `suggest_on_error` code snippet in docs (#144985)
authorSavannah Ostrowski <savannah@python.org>
Mon, 23 Feb 2026 17:25:05 +0000 (09:25 -0800)
committerGitHub <noreply@github.com>
Mon, 23 Feb 2026 17:25:05 +0000 (17:25 +0000)
Doc/library/argparse.rst

index ebcf8bf4dac00240f183eb6f38879d3a212ca814..ca4f439c345f32f0cff2c33a213576be6229dfe6 100644 (file)
@@ -602,18 +602,13 @@ choices (if specified) or subparser names, along with a "maybe you meant"
 suggestion if a close match is found. Note that this only applies for arguments
 when the choices specified are strings::
 
-   >>> parser = argparse.ArgumentParser(description='Process some integers.',
-                                        suggest_on_error=True)
-   >>> parser.add_argument('--action', choices=['sum', 'max'])
-   >>> parser.add_argument('integers', metavar='N', type=int, nargs='+',
-   ...                     help='an integer for the accumulator')
-   >>> parser.parse_args(['--action', 'sumn', 1, 2, 3])
-   tester.py: error: argument --action: invalid choice: 'sumn', maybe you meant 'sum'? (choose from 'sum', 'max')
-
-You can disable suggestions by setting ``suggest_on_error`` to ``False``::
+   >>> parser = argparse.ArgumentParser(suggest_on_error=True)
+   >>> parser.add_argument('--action', choices=['debug', 'dryrun'])
+   >>> parser.parse_args(['--action', 'debugg'])
+   usage: tester.py [-h] [--action {debug,dryrun}]
+   tester.py: error: argument --action: invalid choice: 'debugg', maybe you meant 'debug'? (choose from debug, dryrun)
 
-   >>> parser = argparse.ArgumentParser(description='Process some integers.',
-                                        suggest_on_error=False)
+You can disable suggestions by setting ``suggest_on_error`` to ``False``.
 
 .. versionadded:: 3.14
 .. versionchanged:: 3.15