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/bitcoin_price.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'py3status/modules/bitcoin_price.py') 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 """ 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 -- cgit v1.3