py: docs

quartiq · Nov 28, 2024 · a0e65e2 · a0e65e2
1 parent b537307
commit a0e65e2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/py/miniconf-mqtt/miniconf/__main__.py b/py/miniconf-mqtt/miniconf/__main__.py
@@ -1,3 +1,7 @@
+"""
+Command line interface for Miniconf-over-MQTT (asynchronous)
+"""
+
 import asyncio
 from .async_ import _main
 

diff --git a/py/miniconf-mqtt/miniconf/async_.py b/py/miniconf-mqtt/miniconf/async_.py
@@ -21,8 +21,7 @@
 
 
 class MiniconfException(Exception):
-    """Generic exceptions generated by Miniconf."""
-
+    """Miniconf Error"""
     def __init__(self, code, message):
         self.code = code
         self.message = message

diff --git a/py/miniconf-mqtt/miniconf/sync.py b/py/miniconf-mqtt/miniconf/sync.py
@@ -17,7 +17,7 @@
 
 
 class Miniconf:
-    """An synchronous API for controlling Miniconf devices using MQTT."""
+    """Miniconf over MQTT (synchronous)"""
 
     def __init__(self, client: Client, prefix: str):
         self.client = client