💡 docstrings

xthulu/ssh/codecs/__init__.py

@@ -1,4 +1,4 @@
-"""encodings module"""
+"""Encodings module"""
 
 # stdlib
 from codecs import decode, register

xthulu/ssh/console/__init__.py

@@ -1,3 +1,5 @@
+"""An SSH-integrated Console for use with rich/Textual"""
+
 # typing
 from typing import Any, Mapping
 
@@ -10,6 +12,9 @@
 
 
 class XthuluConsole(Console):
+
+    """Wrapper around rich's Console for integrating with SSHContext queues"""
+
     _encoding: str
 
     def __init__(

xthulu/ssh/console/app.py

@@ -1,3 +1,5 @@
+"""Textual application wrapper"""
+
 # stdlib
 from asyncio import sleep
 

xthulu/ssh/console/art.py

@@ -1,3 +1,5 @@
+"""Artwork display"""
+
 # stdlib
 from asyncio import QueueEmpty, sleep
 from re import Match, sub

xthulu/ssh/console/driver.py

@@ -1,3 +1,5 @@
+"""Console driver"""
+
 # 3rd party
 from asyncio import run_coroutine_threadsafe
 from codecs import getincrementaldecoder
@@ -11,7 +13,11 @@
 
 
 class SSHDriver(LinuxDriver):
+
+    """Textual console driver integrated with SSHContext queues"""
+
     context: SSHContext
+    """The current SSH context"""
 
     def __init__(self, app: XthuluApp, **kwargs) -> None:
         self.context = app.context

xthulu/ssh/console/file_wrapper.py

@@ -1,3 +1,5 @@
+"""File wrapper"""
+
 # typing
 from typing import Any, IO
 
@@ -6,6 +8,9 @@
 
 
 class FileWrapper(IO[str]):
+
+    """Duck-typed wrapper for providing a file-like object to rich/Textual"""
+
     _encoding: str
     _wrapped: SSHWriter[Any]
 

xthulu/ssh/console/input.py

@@ -1,3 +1,5 @@
+"""Input utilities"""
+
 # stdlib
 from asyncio import QueueEmpty, sleep, wait_for