Mention "public" attributes in class docstring

2 files changed, 10 insertions, 2 deletions

diff --git a/alot/walker.py b/alot/walker.py
index 381976ae..a26b2926 100644
--- a/alot/walker.py
+++ b/alot/walker.py
@@ -8,8 +8,12 @@ import urwid
 
 
 class PipeWalker(urwid.ListWalker):
-    """urwid.ListWalker that reads next items from a pipe and
-    wraps them in `containerclass` widgets for displaying
+    """urwid.ListWalker that reads next items from a pipe and wraps them in
+    `containerclass` widgets for displaying
+
+    Atributes that should be considered publicly readable:
+        :attr lines: the lines obtained from the pipe
+        :type lines: list(`containerclass`)
     """
     def __init__(self, pipe, containerclass, reverse=False, **kwargs):
         self.pipe = pipe
diff --git a/alot/widgets/globals.py b/alot/widgets/globals.py
index cb1369d2..95b55465 100644
--- a/alot/widgets/globals.py
+++ b/alot/widgets/globals.py
@@ -279,6 +279,10 @@ class TagWidget(urwid.AttrMap):
 
     It looks up the string it displays in the `tags` section
     of the config as well as custom theme settings for its tag.
+
+    Atributes that should be considered publicly readable:
+        :attr tag: the notmuch tag
+        :type tag: str
     """
     def __init__(self, tag, fallback_normal=None, fallback_focus=None):
         self.tag = tag