From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 30 Nov 2020 21:21:08 +0000 (-0800)
Subject: bpo-42501:  Revise the usage note for Enums with the choices (GH-23563) (GH-23573)
X-Git-Tag: v3.9.1~25
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=aab93903347ec6d7f23dda2994dd26f6111d19d2;p=thirdparty%2FPython%2Fcpython.git

bpo-42501:  Revise the usage note for Enums with the choices (GH-23563) (GH-23573)
---

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 7a7a4cf94979..a32b99901a7b 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1133,20 +1133,9 @@ container should match the type_ specified::
 
 Any container can be passed as the *choices* value, so :class:`list` objects,
 :class:`set` objects, and custom containers are all supported.
-This includes :class:`enum.Enum`, which could be used to restrain
-argument's choices; if we reuse previous rock/paper/scissors game example,
-this could be as follows::
-
-   >>> from enum import Enum
-   >>> class GameMove(Enum):
-   ...     ROCK = 'rock'
-   ...     PAPER = 'paper'
-   ...     SCISSORS = 'scissors'
-   ...
-   >>> parser = argparse.ArgumentParser(prog='game.py')
-   >>> parser.add_argument('move', type=GameMove, choices=GameMove)
-   >>> parser.parse_args(['rock'])
-   Namespace(move=<GameMove.ROCK: 'rock'>)
+
+Use of :class:`enum.Enum` is not recommended because it is difficult to
+control its appearance in usage, help, and error messages.
 
 
 required