From 9a5bb168066b68488c9eee7ecce3de8fe30d4cfc Mon Sep 17 00:00:00 2001 From: Justin Kunimune Date: Thu, 10 Oct 2024 13:56:05 -0400 Subject: [PATCH] Note argparse exit code in documentation (GH-119568) (cherry picked from commit 3b87fb74c907510402678bf1b7c4a94df0e5e65a) Co-authored-by: Justin Kunimune Co-authored-by: Savannah Ostrowski --- Doc/library/argparse.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index abe20d7d611695..6d8b207cbc03ab 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -537,7 +537,8 @@ exit_on_error ^^^^^^^^^^^^^ Normally, when you pass an invalid argument list to the :meth:`~ArgumentParser.parse_args` -method of an :class:`ArgumentParser`, it will exit with error info. +method of an :class:`ArgumentParser`, it will print a *message* to :data:`sys.stderr` and exit with a status +code of 2. If the user would like to catch errors manually, the feature can be enabled by setting ``exit_on_error`` to ``False``::