From e2563462fcef08f0e1ce6f6b02e5a0a6c1d92937 Mon Sep 17 00:00:00 2001 From: Ethan Furman Date: Fri, 28 Jun 2013 19:37:17 -0700 Subject: Added rationale for defaulting to 1 in the functional API. --- Doc/library/enum.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst index 8979181..b919bdc 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 -- cgit v0.12