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/bitcoin_price.py | |
| parent | cdfec19502d0415f92d85ffa48e6bec495ccb644 (diff) | |
move config parameters on every module docstring, overall QA
Diffstat (limited to 'py3status/modules/bitcoin_price.py')
| -rw-r--r-- | py3status/modules/bitcoin_price.py | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/py3status/modules/bitcoin_price.py b/py3status/modules/bitcoin_price.py index 477394f..f530d27 100644 --- a/py3status/modules/bitcoin_price.py +++ b/py3status/modules/bitcoin_price.py @@ -2,6 +2,21 @@ """ Display bitcoin prices using bitcoincharts.com. +Configuration parameters: + - cache_timeout: Should be at least 15 min according to bitcoincharts. + - color_index : Index of the market responsible for coloration, + meaning that the output is going to be green if the + price went up and red if it went down. + default: -1 means no coloration, + except when only one market is selected + - field : Field that is displayed per market, + see http://bitcoincharts.com/about/markets-api/ + - hide_on_error: Display empty response if True, else an error message + - markets : Comma-separated list of markets. Supported markets can + be found at http://bitcoincharts.com/markets/list/ + - symbols : Try to match currency abbreviations to symbols, + e.g. USD -> $, EUR -> € and so on + @author Andre Doser <doser.andre AT gmail.com> """ import json @@ -19,22 +34,7 @@ except ImportError: class Py3status: """ - Configuration parameters: - - cache_timeout: Should be at least 15 min according to bitcoincharts. - - color_index : Index of the market responsible for coloration, - meaning that the output is going to be green if the - price went up and red if it went down. - default: -1 means no coloration, - except when only one market is selected - - field : Field that is displayed per market, - see http://bitcoincharts.com/about/markets-api/ - - hide_on_error: Display empty response if True, else an error message - - markets : Comma-separated list of markets. Supported markets can - be found at http://bitcoincharts.com/markets/list/ - - symbols : Try to match currency abbreviations to symbols, - e.g. USD -> $, EUR -> € and so on """ - # available configuration parameters cache_timeout = 900 color_index = -1 |