From 6afb730e2a8bf0b472b4c3157bcf5b44aa7e6d56 Mon Sep 17 00:00:00 2001 From: Raymond Hettinger Date: Tue, 22 Dec 2020 09:24:26 -0800 Subject: [PATCH] bpo-29030: Document interaction between *choices* and *metavar*. (GH-23884) --- Doc/library/argparse.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 1a298cdd2b5..4542961d781 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -1152,6 +1152,11 @@ Any container can be passed as the *choices* value, so :class:`list` objects, Use of :class:`enum.Enum` is not recommended because it is difficult to control its appearance in usage, help, and error messages. +Formatted choices overrides the default *metavar* which is normally derived +from *dest*. This is usually what you want because the user never sees the +*dest* parameter. If this display isn't desirable (perhaps because there are +many choices), just specify an explicit metavar_. + required ^^^^^^^^