From: Ethan Furman <ethan@stoneleaf.us>
Date: Sat, 29 Jun 2013 02:37:17 +0000 (-0700)
Subject: Added rationale for defaulting to 1 in the functional API.
X-Git-Tag: v3.4.0a1~371
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e2563462fcef08f0e1ce6f6b02e5a0a6c1d92937;p=thirdparty%2FPython%2Fcpython.git

Added rationale for defaulting to 1 in the functional API.
---

diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index 89791819f6e8..b919bdc83970 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -335,6 +335,10 @@ assignment to :class:`Animal` is equivalent to::
     ...   cat = 3
     ...   dog = 4
 
+The reason for defaulting to ``1`` as the starting number and not ``0`` is
+that ``0`` is ``False`` in a boolean sense, but enum members all evaluate
+to ``True``.
+
 Pickling enums created with the functional API can be tricky as frame stack
 implementation details are used to try and figure out which module the
 enumeration is being created in (e.g. it will fail if you use a utility