Add adapter docstrings

DiamondLightSource · Aug 2, 2023 · 1dc6ea3 · 1dc6ea3
1 parent 511722a
commit 1dc6ea3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/src/tickit/adapters/epics.py b/src/tickit/adapters/epics.py
@@ -88,6 +88,8 @@ class OutputRecord:
 
 
 class EpicsAdapter:
+    """An adapter interface for the EpicsIo."""
+
     interrupt_records: Dict[InputRecord, Callable[[], Any]] = {}
     interrupt: RaiseInterrupt
 

diff --git a/src/tickit/adapters/http.py b/src/tickit/adapters/http.py
@@ -5,6 +5,8 @@
 
 
 class HttpAdapter:
+    """An adapter interface for the HttpIo."""
+
     def get_endpoints(self) -> Iterable[Tuple[HttpEndpoint, Callable]]:
         """Returns list of endpoints.
 

diff --git a/src/tickit/adapters/zmq.py b/src/tickit/adapters/zmq.py
@@ -18,7 +18,7 @@
 
 
 class ZeroMqPushAdapter:
-    """Device interface for the Zmq push adapter."""
+    """An adapter interface for the ZeroMqPushIo."""
 
     _message_queue: Optional[asyncio.Queue]