From: Savannah Ostrowski <savannahostrowski@gmail.com>
Date: Sat, 23 Nov 2024 03:18:18 +0000 (-0800)
Subject: GH-127134: Add note about forward compatibility for suggest_on_error (#127137)
X-Git-Tag: v3.14.0a3~230
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a13e94d84bff334da3da2cab523ba75b57e0787f;p=thirdparty%2FPython%2Fcpython.git

GH-127134: Add note about forward compatibility for suggest_on_error (#127137)
---

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index e574511436d1..410b6e11af0d 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