diverse cosmetics to options help strings

This commit is contained in:
hroff-1902 2019-06-23 21:42:46 +03:00
parent 3716c04ed4
commit 7f018839f8

View File

@ -76,7 +76,7 @@ class Arguments(object):
) )
parser.add_argument( parser.add_argument(
'--logfile', '--logfile',
help='Log to the file specified', help='Log to the file specified.',
dest='logfile', dest='logfile',
metavar='FILE', metavar='FILE',
) )
@ -87,7 +87,7 @@ class Arguments(object):
) )
parser.add_argument( parser.add_argument(
'-c', '--config', '-c', '--config',
help=f'Specify configuration file (default: {constants.DEFAULT_CONFIG}). ' help=f'Specify configuration file (default: `{constants.DEFAULT_CONFIG}`). '
f'Multiple --config options may be used. ' f'Multiple --config options may be used. '
f'Can be set to `-` to read config from stdin.', f'Can be set to `-` to read config from stdin.',
dest='config', dest='config',
@ -109,7 +109,7 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'-s', '--strategy', '-s', '--strategy',
help='Specify strategy class name (default: %(default)s).', help='Specify strategy class name (default: `%(default)s`).',
dest='strategy', dest='strategy',
default='DefaultStrategy', default='DefaultStrategy',
metavar='NAME', metavar='NAME',
@ -155,7 +155,7 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'-i', '--ticker-interval', '-i', '--ticker-interval',
help='Specify ticker interval (1m, 5m, 30m, 1h, 1d).', help='Specify ticker interval (`1m`, `5m`, `30m`, `1h`, `1d`).',
dest='ticker_interval', dest='ticker_interval',
) )
parser.add_argument( parser.add_argument(
@ -213,26 +213,25 @@ class Arguments(object):
) )
parser.add_argument( parser.add_argument(
'--strategy-list', '--strategy-list',
help='Provide a commaseparated list of strategies to backtest ' help='Provide a comma-separated list of strategies to backtest. '
'Please note that ticker-interval needs to be set either in config ' 'Please note that ticker-interval needs to be set either in config '
'or via command line. When using this together with --export trades, ' 'or via command line. When using this together with `--export trades`, '
'the strategy-name is injected into the filename ' 'the strategy-name is injected into the filename '
'(so backtest-data.json becomes backtest-data-DefaultStrategy.json', '(so `backtest-data.json` becomes `backtest-data-DefaultStrategy.json`',
nargs='+', nargs='+',
dest='strategy_list', dest='strategy_list',
) )
parser.add_argument( parser.add_argument(
'--export', '--export',
help='Export backtest results, argument are: trades. ' help='Export backtest results, argument are: trades. '
'Example --export=trades', 'Example: `--export=trades`',
dest='export', dest='export',
) )
parser.add_argument( parser.add_argument(
'--export-filename', '--export-filename',
help='Save backtest results to this filename ' help='Save backtest results to the file with this filename (default: `%(default)s`). '
'requires --export to be set as well. ' 'Requires `--export` to be set as well. '
'Example --export-filename=user_data/backtest_data/backtest_today.json ' 'Example: `--export-filename=user_data/backtest_data/backtest_today.json`',
'(default: %(default)s)',
default=os.path.join('user_data', 'backtest_data', 'backtest-result.json'), default=os.path.join('user_data', 'backtest_data', 'backtest-result.json'),
dest='exportfilename', dest='exportfilename',
metavar='PATH', metavar='PATH',
@ -246,9 +245,9 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'--stoplosses', '--stoplosses',
help='Defines a range of stoploss against which edge will assess the strategy ' help='Defines a range of stoploss values against which edge will assess the strategy. '
'the format is "min,max,step" (without any space). ' 'The format is "min,max,step" (without any space). '
'Example: --stoplosses=-0.01,-0.1,-0.001', 'Example: `--stoplosses=-0.01,-0.1,-0.001`',
dest='stoploss_range', dest='stoploss_range',
) )
@ -260,7 +259,7 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'--customhyperopt', '--customhyperopt',
help='Specify hyperopt class name (default: %(default)s).', help='Specify hyperopt class name (default: `%(default)s`).',
dest='hyperopt', dest='hyperopt',
default=constants.DEFAULT_HYPEROPT, default=constants.DEFAULT_HYPEROPT,
metavar='NAME', metavar='NAME',
@ -290,8 +289,8 @@ class Arguments(object):
) )
parser.add_argument( parser.add_argument(
'-s', '--spaces', '-s', '--spaces',
help='Specify which parameters to hyperopt. Space separate list. ' help='Specify which parameters to hyperopt. Space-separated list. '
'Default: %(default)s.', 'Default: `%(default)s`.',
choices=['all', 'buy', 'sell', 'roi', 'stoploss'], choices=['all', 'buy', 'sell', 'roi', 'stoploss'],
default='all', default='all',
nargs='+', nargs='+',
@ -340,7 +339,7 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'-1', '--one-column', '-1', '--one-column',
help='Print exchanges in one column', help='Print exchanges in one column.',
action='store_true', action='store_true',
dest='print_one_column', dest='print_one_column',
) )
@ -443,7 +442,7 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'-p', '--pairs', '-p', '--pairs',
help='Show profits for only this pairs. Pairs are comma-separated.', help='Show profits for only these pairs. Pairs are comma-separated.',
dest='pairs', dest='pairs',
) )
@ -468,14 +467,14 @@ class Arguments(object):
) )
parser.add_argument( parser.add_argument(
'--exchange', '--exchange',
help=f'Exchange name (default: {constants.DEFAULT_EXCHANGE}). ' help=f'Exchange name (default: `{constants.DEFAULT_EXCHANGE}`). '
f'Only valid if no config is provided.', f'Only valid if no config is provided.',
dest='exchange', dest='exchange',
) )
parser.add_argument( parser.add_argument(
'-t', '--timeframes', '-t', '--timeframes',
help=f'Specify which tickers to download. Space separated list. ' help=f'Specify which tickers to download. Space-separated list. '
f'Default: {constants.DEFAULT_DOWNLOAD_TICKER_INTERVALS}.', f'Default: `{constants.DEFAULT_DOWNLOAD_TICKER_INTERVALS}`.',
choices=['1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h', choices=['1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h',
'6h', '8h', '12h', '1d', '3d', '1w'], '6h', '8h', '12h', '1d', '3d', '1w'],
nargs='+', nargs='+',
@ -497,7 +496,7 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'--indicators1', '--indicators1',
help='Set indicators from your strategy you want in the first row of the graph. ' help='Set indicators from your strategy you want in the first row of the graph. '
'Separate them with a coma. E.g: ema3,ema5 (default: %(default)s)', 'Comma-separated list. Example: `ema3,ema5`. Default: `%(default)s`.',
default='sma,ema3,ema5', default='sma,ema3,ema5',
dest='indicators1', dest='indicators1',
) )
@ -505,14 +504,14 @@ class Arguments(object):
parser.add_argument( parser.add_argument(
'--indicators2', '--indicators2',
help='Set indicators from your strategy you want in the third row of the graph. ' help='Set indicators from your strategy you want in the third row of the graph. '
'Separate them with a coma. E.g: fastd,fastk (default: %(default)s)', 'Comma-separated list. Example: `fastd,fastk`. Default: `%(default)s`.',
default='macd,macdsignal', default='macd,macdsignal',
dest='indicators2', dest='indicators2',
) )
parser.add_argument( parser.add_argument(
'--plot-limit', '--plot-limit',
help='Specify tick limit for plotting - too high values cause huge files - ' help='Specify tick limit for plotting. Notice: too high values cause huge files. '
'Default: %(default)s', 'Default: %(default)s.',
dest='plot_limit', dest='plot_limit',
default=750, default=750,
type=int, type=int,