Merge pull request #511 from lesamouraipourpre/examples

[hackapet/Adafruit_Blinka.git] / src / microcontroller / __init__.py

diff --git a/src/microcontroller/__init__.py b/src/microcontroller/__init__.py
index 9e05c81045ea5d1e9485ce6f47ba82ebdbd2adea..fda16cc109c9c1d7c9409e89b2cbe36c4efa10b0 100755 (executable)
--- a/src/microcontroller/__init__.py
+++ b/src/microcontroller/__init__.py
@@ -1,4 +1,9 @@
-"""Microcontroller pins"""
+"""
+`microcontroller` - Pin references and cpu functionality
+========================================================
+
+* Author(s): Melissa LeBlanc-Williams
+"""
 
 import sys
 import time
@@ -14,7 +19,12 @@ def delay_us(delay):
 
 
 class Pin(Enum):
-    """Reference Pin object"""
+    """
+    Identifies an IO pin on the microcontroller.
+
+    They are fixed by the hardware so they cannot be constructed on demand. Instead, use board or
+    microcontroller.pin to reference the desired pin.
+    """
 
     def __init__(self, pin_id):
         """Identifier for pin, referencing platform-specific pin id"""