Docstrings

This commit is contained in:
enkore 2013-02-23 18:41:53 +01:00
parent 9dc7041997
commit 60be03126d
3 changed files with 12 additions and 8 deletions

View File

@ -21,6 +21,10 @@ class Thunderbird(Backend):
""" """
This class listens for dbus signals emitted by This class listens for dbus signals emitted by
the dbus-sender extension for thunderbird. the dbus-sender extension for thunderbird.
Requires
* python-dbus
* python-gobject2
""" """
unread = set() unread = set()

View File

@ -19,7 +19,8 @@ class ModsDeChecker(IntervalModule):
settings = ( settings = (
("format", """Use {unread} as the formatter for number of unread posts"""), ("format", """Use {unread} as the formatter for number of unread posts"""),
"color", "offset", "username", "password" ("offset", """subtract number of posts before output"""),
"color", "username", "password"
) )
required = ("username", "password") required = ("username", "password")

View File

@ -5,17 +5,16 @@ from i3pystatus import IntervalModule
class Regex(IntervalModule): class Regex(IntervalModule):
""" """
Simple regex file watcher Simple regex file watcher
Settings:
* flags Python.re flags
* regex regular expression
* file file to search for regex matches
* format new-style format string used for output, default is "{0}"
""" """
flags = 0 flags = 0
format = "{0}" format = "{0}"
settings = ("format", "regex", "file") settings = (
("format", "format string used for output"),
"regex",
("file", "file to search for regex matches"),
("flags", "Python.re flags"),
)
required = ("regex", "file") required = ("regex", "file")
def init(self): def init(self):