diff options
| author | Ultrabug <ultrabug@gentoo.org> | 2015-03-31 13:10:08 +0200 |
|---|---|---|
| committer | Ultrabug <ultrabug@gentoo.org> | 2015-03-31 13:10:08 +0200 |
| commit | cdfec19502d0415f92d85ffa48e6bec495ccb644 (patch) | |
| tree | 8f42927aca460bb02547733b2c367af91b142f7b /doc | |
| parent | d788ae674cfb1610e2a12fe2df1e7f84bab7fd99 (diff) | |
update example_module for config parameters doc
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/example_module.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/example_module.py b/doc/example_module.py index 7db53fd..d132eed 100644 --- a/doc/example_module.py +++ b/doc/example_module.py @@ -38,6 +38,9 @@ One-line summary followed by an empty line. Multi-line description followed by an empty line. +Configuration parameters: + - cache_timeout : how often we refresh this module in seconds + @author <your full name> <your email address> @license BSD """ @@ -57,7 +60,6 @@ class Py3status: This examples features only one parameter which is 'cache_timeout' and is set to 10 seconds (0 would mean no cache). """ - # available configuration parameters cache_timeout = 10 |