fix up docs

BrianPugh · Dec 1, 2022 · a91b023 · a91b023
1 parent bcef761
commit a91b023
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/belay/__init__.py b/belay/__init__.py
@@ -3,12 +3,15 @@
 
 __all__ = [
     "AuthenticationError",
-    "minify",
+    "ConnectionLost",
     "Device",
-    "SpecialFunctionNameError",
-    "PyboardException",
-    "Implementation",
     "FeatureUnavailableError",
+    "Implementation",
+    "MaxHistoryLengthError",
+    "PyboardException",
+    "SpecialFunctionNameError",
+    "list_devices",
+    "minify",
 ]
 from ._minify import minify
 from .device import Device, Implementation
@@ -19,5 +22,5 @@
     MaxHistoryLengthError,
     SpecialFunctionNameError,
 )
-from .pyboard import PyboardException
 from .helpers import list_devices
+from .pyboard import PyboardException
diff --git a/belay/helpers.py b/belay/helpers.py
@@ -30,6 +30,10 @@ def read_snippet(name):
 def list_devices() -> List[str]:
     """Lists available device ports.
 
+    For example::
+
+        ['/dev/cu.usbmodem1143401', '/dev/cu.usbmodem113101']
+
     Returns
     -------
     list[str]