From ada99c0af5665828abc725923bf2f104c577c852 Mon Sep 17 00:00:00 2001 From: Ultrabug Date: Tue, 31 Mar 2015 13:14:25 +0200 Subject: move config parameters on every module docstring, overall QA --- py3status/modules/imap.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'py3status/modules/imap.py') diff --git a/py3status/modules/imap.py b/py3status/modules/imap.py index 47661f1..07190dd 100644 --- a/py3status/modules/imap.py +++ b/py3status/modules/imap.py @@ -2,6 +2,18 @@ """ Display the unread messages count from your IMAP account. +Configuration parameters: + - cache_timeout : how often to run this check + - criterion : status of emails to check for + - hide_if_zero : don't show on bar if 0 + - imap_server : IMAP server to connect to + - mailbox : name of the mailbox to check + - name : format to display + - new_mail_color : what color to output on new mail + - password : login password + - port : IMAP server port + - user : login user + @author obb """ @@ -10,7 +22,8 @@ from time import time class Py3status: - + """ + """ # available configuration parameters cache_timeout = 60 criterion = 'UNSEEN' -- cgit v1.3