diff options
| author | Ultrabug <ultrabug@gentoo.org> | 2015-03-31 13:14:25 +0200 |
|---|---|---|
| committer | Ultrabug <ultrabug@gentoo.org> | 2015-03-31 13:14:25 +0200 |
| commit | ada99c0af5665828abc725923bf2f104c577c852 (patch) | |
| tree | a4e58a0d9a5bec4612efe98bf068730a45c32ef7 /py3status/modules/net_rate.py | |
| parent | cdfec19502d0415f92d85ffa48e6bec495ccb644 (diff) | |
move config parameters on every module docstring, overall QA
Diffstat (limited to 'py3status/modules/net_rate.py')
| -rw-r--r-- | py3status/modules/net_rate.py | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/py3status/modules/net_rate.py b/py3status/modules/net_rate.py index 961578b..705728a 100644 --- a/py3status/modules/net_rate.py +++ b/py3status/modules/net_rate.py @@ -2,6 +2,21 @@ """ Display the current network transfer rate. +Confiuration parameters: + - all_interfaces : ignore self.interfaces, but not self.interfaces_blacklist + - devfile : location of dev file under /proc + - format_no_connection : when there is no data transmitted from the start of the plugin + - hide_if_zero : hide indicator if rate == 0 + - interfaces : comma separated list of interfaces to track + - interfaces_blacklist : comma separated list of interfaces to ignore + - precision : amount of numbers after dot + +Format of status string placeholders: + {down} - download rate + {interface} - name of interface + {total} - total rate + {up} - upload rate + @author shadowprince @license Eclipse Public License """ @@ -17,22 +32,7 @@ UNITS = ["kb/s", "mb/s", "gb/s", "tb/s", ] # list of units, first one - value/I class Py3status: """ - Confiuration parameters: - - all_interfaces : ignore self.interfaces, but not self.interfaces_blacklist - - devfile : location of dev file under /proc - - format_no_connection : when there is no data transmitted from the start of the plugin - - hide_if_zero : hide indicator if rate == 0 - - interfaces : comma separated list of interfaces to track - - interfaces_blacklist : comma separated list of interfaces to ignore - - precision : amount of numbers after dot - - Format of status string placeholders: - interface - name of interface - total - total rate - up - upload rate - down - download rate """ - # available configuration parameters all_interfaces = True cache_timeout = 2 |
