Add a bit more documentation

Author: robtaylor

chipflow_lib/__init__.py

@@ -1,3 +1,7 @@
+"""
+Chipflow library
+"""
+
 import importlib.metadata
 import os
 import sys
@@ -7,7 +11,6 @@
 
 __version__ = importlib.metadata.version("chipflow_lib")
 
-
 class ChipFlowError(Exception):
     pass
 

chipflow_lib/platforms/__init__.py

@@ -1,3 +1,15 @@
+"""
+Platform definititions
+----------------------
+
+This module defines the functionality you use in you code to target the ChipFlow platform
+
+"""
+
 from .silicon import *
 from .sim import *
 from .utils import *
+
+__all__ = ['PIN_ANNOTATION_SCHEMA', 'PinSignature',
+           'OutputPinSignature', 'InputPinSignature', 'BidirPinSignature',
+           'load_pinlock', "PACKAGE_DEFINITIONS", 'top_interfaces']

chipflow_lib/platforms/utils.py

@@ -99,13 +99,24 @@ def __init__(self, direction: io.Direction, width: int = 1, all_have_oe: bool =
         super().__init__(sig)
 
     @property
-    def direction(self):
+    def direction(self) -> io.Direction:
+        "The direction of the IO port"
         return self._direction
 
-    def width(self):
+    def width(self) -> int:
+        "The width of the IO port, in wires"
         return self._width
 
-    def options(self):
+    def options(self) -> dict:
+        """
+        Options set on the io port at construction
+
+        Valid options are:
+            "all_have_oe": For a bidirectional port, each wire can
+            have it's direction dynamically controlled seperately,
+            so each wire also has a corresponding Output Enable wire.
+            "init": the initial value that this io port will have at power-up and reset.
+        """
         return self._options
 
     def annotations(self, *args):