From 72b312cd98191e99426c39f6292f8d3087eec15f Mon Sep 17 00:00:00 2001 From: Ethan Furman Date: Mon, 14 Sep 2020 13:32:44 -0700 Subject: [PATCH] bpo-40721: add note about enum member name case (GH-22231) * UPPER_CASE preferred as enum members are constants (cherry picked from commit 542e1df2b018ee7068dba8076f2d6e84efd6e144) Co-authored-by: Ethan Furman --- Doc/library/enum.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 03aa2f1b21655f..8753416a27416f 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 ---------------