From a91b023175bac9021e38e01a2699bc4bc441136d Mon Sep 17 00:00:00 2001 From: Brian Pugh Date: Thu, 1 Dec 2022 09:20:44 -0800 Subject: [PATCH] fix up docs --- belay/__init__.py | 13 ++++++++----- belay/helpers.py | 4 ++++ 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/belay/__init__.py b/belay/__init__.py index 38f6556..b4b326b 100644 --- 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 index 219cf4a..4bffdb0 100644 --- 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]