summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorSavannah Ostrowski <savannahostrowski@gmail.com>2024-11-23 03:18:18 (GMT)
committerGitHub <noreply@github.com>2024-11-23 03:18:18 (GMT)
commita13e94d84bff334da3da2cab523ba75b57e0787f (patch)
treed39c0033a043324003b7617577e4e680296ef8dc /Doc
parent39e60aeb3837f1f23d8b7f30d3b8d9faf805ef88 (diff)
downloadcpython-a13e94d84bff334da3da2cab523ba75b57e0787f.zip
cpython-a13e94d84bff334da3da2cab523ba75b57e0787f.tar.gz
cpython-a13e94d84bff334da3da2cab523ba75b57e0787f.tar.bz2
GH-127134: Add note about forward compatibility for suggest_on_error (#127137)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/argparse.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index e574511..410b6e1 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -589,6 +589,14 @@ are strings::
>>> parser.parse_args(['--action', 'sumn', 1, 2, 3])
tester.py: error: argument --action: invalid choice: 'sumn', maybe you meant 'sum'? (choose from 'sum', 'max')
+If you're writing code that needs to be compatible with older Python versions
+and want to opportunistically use ``suggest_on_error`` when it's available, you
+can set it as an attribute after initializing the parser instead of using the
+keyword argument::
+
+ >>> parser = argparse.ArgumentParser(description='Process some integers.')
+ >>> parser.suggest_on_error = True
+
.. versionadded:: 3.14