From 3b976d60a80326dae8f6d00e13e9de05857a7478 Mon Sep 17 00:00:00 2001 From: Ethan Furman Date: Sun, 13 Sep 2020 14:02:54 -0700 Subject: [PATCH 1/2] add note about enum member name case --- Doc/library/enum.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 00bfb260c02047..f10c0a9a9c2336 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -19,6 +19,11 @@ 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 will be using + UPPER_CASE names in our examples. + Module Contents --------------- From fb01fd8b50a9719b5b562d3a748b75375c69886b Mon Sep 17 00:00:00 2001 From: Ethan Furman Date: Sun, 13 Sep 2020 14:07:34 -0700 Subject: [PATCH 2/2] improve note --- Doc/library/enum.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index f10c0a9a9c2336..32e8bbf9509273 100644 --- a/Doc/library/enum.rst +++ b/Doc/library/enum.rst @@ -21,8 +21,9 @@ by identity, and the enumeration itself can be iterated over. .. note:: Case of Enum Members - Because Enums are used to represent constants we will be using - UPPER_CASE names in our examples. + 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