summaryrefslogtreecommitdiffstats
path: root/py3status/modules/online_status.py
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
committerUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
commitada99c0af5665828abc725923bf2f104c577c852 (patch)
treea4e58a0d9a5bec4612efe98bf068730a45c32ef7 /py3status/modules/online_status.py
parentcdfec19502d0415f92d85ffa48e6bec495ccb644 (diff)
move config parameters on every module docstring, overall QA
Diffstat (limited to 'py3status/modules/online_status.py')
-rw-r--r--py3status/modules/online_status.py13
1 files changed, 7 insertions, 6 deletions
diff --git a/py3status/modules/online_status.py b/py3status/modules/online_status.py
index 8176d21..7b6d7d6 100644
--- a/py3status/modules/online_status.py
+++ b/py3status/modules/online_status.py
@@ -2,6 +2,13 @@
"""
Display if a connection to the internet is established.
+Configuration parameters:
+ - cache_timeout : how often to run the check
+ - format_offline : what to display when offline
+ - format_online : what to display when online
+ - timeout : how long before deciding we're offline
+ - url : connect to this url to check the connection status
+
@author obb
"""
@@ -15,12 +22,6 @@ except:
class Py3status:
"""
- Configuration parameters:
- - cache_timeout : how often to run the check
- - format_offline : what to display when offline
- - format_online : what to display when online
- - timeout : how long before deciding we're offline
- - url : connect to this url to check the connection status
"""
# available configuration parameters
cache_timeout = 10