From: Ethan Furman <ethan@stoneleaf.us>
Date: Mon, 14 Sep 2020 20:32:44 +0000 (-0700)
Subject: bpo-40721: add note about enum member name case (GH-22231)
X-Git-Tag: v3.10.0a1~119
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=542e1df2b018ee7068dba8076f2d6e84efd6e144;p=thirdparty%2FPython%2Fcpython.git

bpo-40721: add note about enum member name case (GH-22231)

* UPPER_CASE preferred as enum members are constants
---

diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index 00bfb260c020..32e8bbf95092 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -19,6 +19,12 @@ An enumeration is a set of symbolic names (members) bound to unique,
 constant values.  Within an enumeration, the members can be compared
 by identity, and the enumeration itself can be iterated over.
 
+.. note:: Case of Enum Members
+
+    Because Enums are used to represent constants we recommend using
+    UPPER_CASE names for enum members, and will be using that style
+    in our examples.
+
 
 Module Contents
 ---------------