From e34ea393d91edc855e6140af8e563e9571605c3e Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 17 Aug 2025 15:15:55 +0200 Subject: [PATCH] docs: improved help wording --- docs/commands/backtesting-analysis.md | 6 +++--- docs/commands/backtesting-show.md | 7 ++++--- docs/commands/backtesting.md | 6 +++--- docs/commands/lookahead-analysis.md | 6 +++--- docs/commands/plot-dataframe.md | 2 +- docs/commands/plot-profit.md | 2 +- freqtrade/commands/cli_options.py | 4 ++-- 7 files changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/commands/backtesting-analysis.md b/docs/commands/backtesting-analysis.md index 35462d18c..826792f4f 100644 --- a/docs/commands/backtesting-analysis.md +++ b/docs/commands/backtesting-analysis.md @@ -3,7 +3,7 @@ usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--backtest-filename PATH] - [--export-directory PATH] + [--backtest-directory PATH] [--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]] [--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]] [--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]] @@ -19,9 +19,9 @@ options: Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. - Assumes either user_data/backtest_results/ or + Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --export-directory PATH, --backtest-directory PATH + --backtest-directory PATH, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...] diff --git a/docs/commands/backtesting-show.md b/docs/commands/backtesting-show.md index 3a1b4be2b..eb9c7137b 100644 --- a/docs/commands/backtesting-show.md +++ b/docs/commands/backtesting-show.md @@ -2,7 +2,8 @@ usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--backtest-filename PATH] - [--export-directory PATH] [--show-pair-list] + [--backtest-directory PATH] + [--show-pair-list] [--breakdown {day,week,month,year} [{day,week,month,year} ...]] options: @@ -11,9 +12,9 @@ options: Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. - Assumes either user_data/backtest_results/ or + Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --export-directory PATH, --backtest-directory PATH + --backtest-directory PATH, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --show-pair-list Show backtesting pairlist sorted by profit. diff --git a/docs/commands/backtesting.md b/docs/commands/backtesting.md index 55ed392d8..7082fb362 100644 --- a/docs/commands/backtesting.md +++ b/docs/commands/backtesting.md @@ -15,7 +15,7 @@ usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--export {none,trades,signals}] [--backtest-filename PATH] - [--export-directory PATH] + [--backtest-directory PATH] [--breakdown {day,week,month,year} [{day,week,month,year} ...]] [--cache {none,day,week,month}] [--freqai-backtest-live-models] [--notes TEXT] @@ -66,9 +66,9 @@ options: Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. - Assumes either user_data/backtest_results/ or + Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --export-directory PATH, --backtest-directory PATH + --backtest-directory PATH, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --breakdown {day,week,month,year} [{day,week,month,year} ...] diff --git a/docs/commands/lookahead-analysis.md b/docs/commands/lookahead-analysis.md index 29d64940a..880c41ce1 100644 --- a/docs/commands/lookahead-analysis.md +++ b/docs/commands/lookahead-analysis.md @@ -16,7 +16,7 @@ usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--export {none,trades,signals}] [--backtest-filename PATH] - [--export-directory PATH] + [--backtest-directory PATH] [--freqai-backtest-live-models] [--minimum-trade-amount INT] [--targeted-trade-amount INT] @@ -65,9 +65,9 @@ options: Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. - Assumes either user_data/backtest_results/ or + Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --export-directory PATH, --backtest-directory PATH + --backtest-directory PATH, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --freqai-backtest-live-models diff --git a/docs/commands/plot-dataframe.md b/docs/commands/plot-dataframe.md index 8fc066aab..a709858f3 100644 --- a/docs/commands/plot-dataframe.md +++ b/docs/commands/plot-dataframe.md @@ -42,7 +42,7 @@ options: Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. - Assumes either user_data/backtest_results/ or + Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. --timerange TIMERANGE Specify what timerange of data to use. diff --git a/docs/commands/plot-profit.md b/docs/commands/plot-profit.md index 1579adbe1..e46e4b223 100644 --- a/docs/commands/plot-profit.md +++ b/docs/commands/plot-profit.md @@ -23,7 +23,7 @@ options: Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. - Assumes either user_data/backtest_results/ or + Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. --db-url PATH Override trades database URL, this is useful in custom deployments (default: `sqlite:///tradesv3.sqlite` for diff --git a/freqtrade/commands/cli_options.py b/freqtrade/commands/cli_options.py index 19e229e7d..b4641597d 100755 --- a/freqtrade/commands/cli_options.py +++ b/freqtrade/commands/cli_options.py @@ -210,8 +210,8 @@ AVAILABLE_CLI_OPTIONS = { choices=constants.EXPORT_OPTIONS, ), "exportdirectory": Arg( - "--export-directory", "--backtest-directory", + "--export-directory", help="Directory to use for backtest results. " "Example: `--export-directory=user_data/backtest_results/`. ", metavar="PATH", @@ -221,7 +221,7 @@ AVAILABLE_CLI_OPTIONS = { "--export-filename", help="Use this filename for backtest results." "Example: `--backtest-filename=backtest_results_2020-09-27_16-20-48.json`. " - "Assumes either user_data/backtest_results/ or `--export-directory` as base directory.", + "Assumes either `user_data/backtest_results/` or `--export-directory` as base directory.", metavar="PATH", ), "disableparamexport": Arg(