A bit more documentation

fruit-testbed · May 17, 2018 · 2794e88 · 2794e88
1 parent 24c9f37
commit 2794e88
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/pistack/__init__.py b/pistack/__init__.py
@@ -1,3 +1,5 @@
 # -*- coding: utf-8 -*-
-
+"""
+    Interface to control the Pi Stack boards
+"""
 from pistack import *
diff --git a/pistack/comms.py b/pistack/comms.py
@@ -27,6 +27,12 @@ class Comms(object):
         Handle all comms over the serial link
     """
     def __init__(self, port_name, baud=_DEFAULT_BAUD, timeout=_DEFAULT_TIMEOUT):
+        """
+            Create the interface for the Pi Stack boards
+            :param port_name: The serial port to use
+            :param baud: OPTIONAL: The baud rate to use
+            :param timeout: OPTIONAL: The timeout to use
+        """
         self._port_name = port_name
         self._baudrate = baud
         self._timeout = timeout