]> granicus.if.org Git - python/commitdiff
Close issue20412: Updated Enum docs to have referencable Enum and IntEnum classes
authorEthan Furman <ethan@stoneleaf.us>
Thu, 6 Feb 2014 16:13:14 +0000 (08:13 -0800)
committerEthan Furman <ethan@stoneleaf.us>
Thu, 6 Feb 2014 16:13:14 +0000 (08:13 -0800)
Doc/library/enum.rst

index 2d206107b43c7ef0061a7cf79a510f1bffae36ab..13f8a3c4e2e19716c669b77c7bdb3521ce9a4d61 100644 (file)
 
 ----------------
 
-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.
+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.
+
+
+Module Contents
+---------------
 
 This module defines two enumeration classes that can be used to define unique
 sets of names and values: :class:`Enum` and :class:`IntEnum`.  It also defines
-one decorator, :func:`unique`, that ensures only unique member values are
-present in an enumeration.
+one decorator, :func:`unique`.
+
+.. class:: Enum
+
+    Base class for creating enumerated constants.  See section
+    :ref:`Functional API` for an alternate construction syntax.
+
+.. class:: IntEnum
+
+    Base class for creating enumerated constants that are also
+    subclasses of :class:`int`.
+
+.. function:: unique
+
+    Enum class decorator that ensures only one name is bound to any one value.
 
 
 Creating an Enum