From a13e94d84bff334da3da2cab523ba75b57e0787f Mon Sep 17 00:00:00 2001 From: Savannah Ostrowski Date: Fri, 22 Nov 2024 19:18:18 -0800 Subject: [PATCH] GH-127134: Add note about forward compatibility for suggest_on_error (#127137) --- Doc/library/argparse.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index e574511436d..410b6e11af0 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