From: Christian Heller <c.heller@plomlompom.de>
Date: Mon, 11 Aug 2025 07:59:53 +0000 (+0200)
Subject: Add some more docstrings.
X-Git-Url: https://plomlompom.com/repos/booking/%7B%7Bdb.prefix%7D%7D/%7B%7B%20web_path%20%7D%7D/%7B%7Bprefix%7D%7D/blog?a=commitdiff_plain;h=393e12753946264c826456e21872f46c03f5e525;p=ircplom

Add some more docstrings.
---

diff --git a/ircplom/tui_base.py b/ircplom/tui_base.py
index 13e002b..7542ebb 100644
--- a/ircplom/tui_base.py
+++ b/ircplom/tui_base.py
@@ -334,14 +334,17 @@ class Window:
             self.set_geometry()
 
     def taint(self) -> None:
+        'Declare all widgets as in need of re-drawing.'
         self.history.taint()
         self.prompt.taint()
 
     @property
     def tainted(self) -> bool:
+        'If any widget in need of re-drawing.'
         return self.history.tainted or self.prompt.tainted
 
     def set_geometry(self) -> None:
+        'Set geometry for widgets.'
         self._drawable = False
         if self._term.size.y < _MIN_HEIGHT or self._term.size.x < _MIN_WIDTH:
             for widget in (self.history, self.prompt):
@@ -358,6 +361,7 @@ class Window:
         return self._title
 
     def draw_tainted(self) -> None:
+        'Draw tainted widgets (or message that screen too small).'
         if self._drawable:
             for widget in [w for w in (self.history, self.prompt)
                            if w.tainted]: