X-Git-Url: https://git.ayoreis.com/hackapet/Adafruit_Blinka.git/blobdiff_plain/a8ed516cc3b6c4cdd7a346f897aa1a520071a239..e7fee263ecca5ed166b9d3cef21c366d7c665b9f:/src/adafruit_blinka/__init__.py

diff --git a/src/adafruit_blinka/__init__.py b/src/adafruit_blinka/__init__.py
old mode 100644
new mode 100755
index 08ec27e..845c802
--- a/src/adafruit_blinka/__init__.py
+++ b/src/adafruit_blinka/__init__.py
@@ -1,5 +1,9 @@
-"""Module providing runtime utility objects to support the Micro/CircuitPython api"""
+"""
+`adafruit_blinka` - Runtime utility objects for re-implementation of CircuitPython API
+======================================================================================
 
+* Author(s): cefn
+"""
 
 class Enum(object):
     """
@@ -27,35 +31,43 @@ class Enum(object):
         """
         for key in dir(cls):
             val = getattr(cls, key)
-            if type(val) is cls:
+            if isinstance(cls, val):
                 yield (key, val)
 
 
 class ContextManaged:
+    """An object that automatically deinitializes hardware with a context manager."""
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         self.deinit()
 
+    def deinit(self):
+        """Free any hardware used by the object."""
+        pass
+
 
 class Lockable(ContextManaged):
+    """An object that must be locked to prevent collisions on a microcontroller resource."""
     _locked = False
 
     def try_lock(self):
+        """Attempt to grab the lock. Return True on success, False if the lock is already taken."""
         if self._locked:
             return False
-        else:
-            self._locked = True
-            return True
+        self._locked = True
+        return True
 
     def unlock(self):
+        """Release the lock so others may use the resource."""
         if self._locked:
             self._locked = False
         else:
             raise ValueError("Not locked")
 
 def patch_system():
+    """Patch modules that may be different due to the platform."""
     import sys
     from adafruit_blinka.agnostic import time
-    sys.modules['time'] = time
\ No newline at end of file
+    sys.modules['time'] = time