Commented

[hackapet/Adafruit_Blinka.git] / python / mcp / __init__.py

diff --git a/python/mcp/__init__.py b/python/mcp/__init__.py
index d52c0b9cfe635834f58b595fb68d28c85809cb2e..c29025003703c598939431b24f8836b024e5a280 100644 (file)
--- a/python/mcp/__init__.py
+++ b/python/mcp/__init__.py
@@ -1,8 +1,17 @@
-class Enum(object):
+"""Module providing runtime utility objects to support the Micro/CircuitPython api"""

 
 

+class Enum(object):
+    """
+        Object supporting CircuitPython-style of static symbols
+        as seen with Direction.OUTPUT, Pull.UP
+    """

 
     @classmethod
     def iteritems(cls):
 
     @classmethod
     def iteritems(cls):

+        """
+            Inspects attributes of the class for instances of the class
+            and returns as key,value pairs mirroring dict#iteritems
+        """

         for key in dir(cls):
             val = getattr(cls, key)
             if type(val) is cls:
         for key in dir(cls):
             val = getattr(cls, key)
             if type(val) is cls:


@@ -11,8 +20,9 @@ class Enum(object):
 
     def __repr__(self):
         """
 
     def __repr__(self):
         """

-        Assumes instance will be found as attribute of own
-        class. Returns dot-subscripted path to instance
+        Assumes instance will be found as attribute of own class.
+        Returns dot-subscripted path to instance
+        (assuming absolute import of containing package)

         """
         cls = type(self)
         for key in dir(cls):
         """
         cls = type(self)
         for key in dir(cls):