From 10d79f62328a65b860a04835c0bc68b72531460c Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 18 Apr 2025 14:59:06 +0200 Subject: [PATCH] feat: update --datadir description Updates across all subcommands and when running with `--help`. --- docs/commands/backtesting-analysis.md | 4 +++- docs/commands/backtesting-show.md | 4 +++- docs/commands/backtesting.md | 4 +++- docs/commands/convert-data.md | 4 +++- docs/commands/convert-trade-data.md | 4 +++- docs/commands/download-data.md | 4 +++- docs/commands/edge.md | 4 +++- docs/commands/hyperopt-list.md | 4 +++- docs/commands/hyperopt-show.md | 4 +++- docs/commands/hyperopt.md | 4 +++- docs/commands/list-data.md | 5 +++-- docs/commands/list-exchanges.md | 4 +++- docs/commands/list-freqaimodels.md | 4 +++- docs/commands/list-hyperoptloss.md | 4 +++- docs/commands/list-markets.md | 4 +++- docs/commands/list-pairs.md | 4 +++- docs/commands/list-strategies.md | 4 +++- docs/commands/list-timeframes.md | 4 +++- docs/commands/lookahead-analysis.md | 4 +++- docs/commands/plot-dataframe.md | 4 +++- docs/commands/plot-profit.md | 4 +++- docs/commands/recursive-analysis.md | 4 +++- docs/commands/show-trades.md | 4 +++- docs/commands/strategy-updater.md | 4 +++- docs/commands/trade.md | 4 +++- docs/commands/trades-to-ohlcv.md | 4 +++- docs/commands/webserver.md | 4 +++- freqtrade/commands/cli_options.py | 3 ++- 28 files changed, 83 insertions(+), 29 deletions(-) diff --git a/docs/commands/backtesting-analysis.md b/docs/commands/backtesting-analysis.md index 50707d03a..6aa18d670 100644 --- a/docs/commands/backtesting-analysis.md +++ b/docs/commands/backtesting-analysis.md @@ -59,7 +59,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/backtesting-show.md b/docs/commands/backtesting-show.md index a1b146a82..6a4565616 100644 --- a/docs/commands/backtesting-show.md +++ b/docs/commands/backtesting-show.md @@ -30,7 +30,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/backtesting.md b/docs/commands/backtesting.md index 395ab4b00..c54d9e40c 100644 --- a/docs/commands/backtesting.md +++ b/docs/commands/backtesting.md @@ -89,7 +89,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/convert-data.md b/docs/commands/convert-data.md index 3bd0fa45b..32996eba3 100644 --- a/docs/commands/convert-data.md +++ b/docs/commands/convert-data.md @@ -45,7 +45,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/convert-trade-data.md b/docs/commands/convert-trade-data.md index 25843a8da..cf53e5329 100644 --- a/docs/commands/convert-trade-data.md +++ b/docs/commands/convert-trade-data.md @@ -34,7 +34,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/download-data.md b/docs/commands/download-data.md index e70ae9a23..ce80e704e 100644 --- a/docs/commands/download-data.md +++ b/docs/commands/download-data.md @@ -63,7 +63,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/edge.md b/docs/commands/edge.md index 06f883230..c69a63583 100644 --- a/docs/commands/edge.md +++ b/docs/commands/edge.md @@ -50,7 +50,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/hyperopt-list.md b/docs/commands/hyperopt-list.md index 5e8398f51..8457aba27 100644 --- a/docs/commands/hyperopt-list.md +++ b/docs/commands/hyperopt-list.md @@ -55,7 +55,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/hyperopt-show.md b/docs/commands/hyperopt-show.md index 14d6516e9..5cd114c17 100644 --- a/docs/commands/hyperopt-show.md +++ b/docs/commands/hyperopt-show.md @@ -37,7 +37,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/hyperopt.md b/docs/commands/hyperopt.md index 28ad45dd2..e7a05bedf 100644 --- a/docs/commands/hyperopt.md +++ b/docs/commands/hyperopt.md @@ -103,7 +103,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-data.md b/docs/commands/list-data.md index 8bc83d707..515207178 100644 --- a/docs/commands/list-data.md +++ b/docs/commands/list-data.md @@ -41,8 +41,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to the base directory of the exchange with historical backtesting data. - To see futures data, use trading-mode additionally. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-exchanges.md b/docs/commands/list-exchanges.md index c95ae3ebd..f551c8aa8 100644 --- a/docs/commands/list-exchanges.md +++ b/docs/commands/list-exchanges.md @@ -22,7 +22,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-freqaimodels.md b/docs/commands/list-freqaimodels.md index 3e66880ab..c4a588eba 100644 --- a/docs/commands/list-freqaimodels.md +++ b/docs/commands/list-freqaimodels.md @@ -24,7 +24,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-hyperoptloss.md b/docs/commands/list-hyperoptloss.md index 1a1604b0f..2762c3fe7 100644 --- a/docs/commands/list-hyperoptloss.md +++ b/docs/commands/list-hyperoptloss.md @@ -24,7 +24,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-markets.md b/docs/commands/list-markets.md index d33b9c5d1..d2233e1da 100644 --- a/docs/commands/list-markets.md +++ b/docs/commands/list-markets.md @@ -39,7 +39,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-pairs.md b/docs/commands/list-pairs.md index 3d8e677ee..3f991e414 100644 --- a/docs/commands/list-pairs.md +++ b/docs/commands/list-pairs.md @@ -39,7 +39,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-strategies.md b/docs/commands/list-strategies.md index af5771860..95f79e175 100644 --- a/docs/commands/list-strategies.md +++ b/docs/commands/list-strategies.md @@ -27,7 +27,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/list-timeframes.md b/docs/commands/list-timeframes.md index 8dc10a789..bcd45b151 100644 --- a/docs/commands/list-timeframes.md +++ b/docs/commands/list-timeframes.md @@ -23,7 +23,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/lookahead-analysis.md b/docs/commands/lookahead-analysis.md index bb7ef5d8e..7870d212e 100644 --- a/docs/commands/lookahead-analysis.md +++ b/docs/commands/lookahead-analysis.md @@ -89,7 +89,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/plot-dataframe.md b/docs/commands/plot-dataframe.md index 81ecc0da7..e101d0d5b 100644 --- a/docs/commands/plot-dataframe.md +++ b/docs/commands/plot-dataframe.md @@ -63,7 +63,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/plot-profit.md b/docs/commands/plot-profit.md index 207697a93..2c0b0e6b5 100644 --- a/docs/commands/plot-profit.md +++ b/docs/commands/plot-profit.md @@ -49,7 +49,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/recursive-analysis.md b/docs/commands/recursive-analysis.md index b39e8fb35..39b4fc3da 100644 --- a/docs/commands/recursive-analysis.md +++ b/docs/commands/recursive-analysis.md @@ -41,7 +41,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/show-trades.md b/docs/commands/show-trades.md index 316d47448..6ac64cae7 100644 --- a/docs/commands/show-trades.md +++ b/docs/commands/show-trades.md @@ -30,7 +30,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/strategy-updater.md b/docs/commands/strategy-updater.md index ba40322ec..c2804fee2 100644 --- a/docs/commands/strategy-updater.md +++ b/docs/commands/strategy-updater.md @@ -34,7 +34,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/trade.md b/docs/commands/trade.md index b689902c2..0189669c0 100644 --- a/docs/commands/trade.md +++ b/docs/commands/trade.md @@ -36,7 +36,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/trades-to-ohlcv.md b/docs/commands/trades-to-ohlcv.md index c2d42a5cc..748a8ace5 100644 --- a/docs/commands/trades-to-ohlcv.md +++ b/docs/commands/trades-to-ohlcv.md @@ -41,7 +41,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/docs/commands/webserver.md b/docs/commands/webserver.md index a99b83e97..1ac7bd13b 100644 --- a/docs/commands/webserver.md +++ b/docs/commands/webserver.md @@ -20,7 +20,9 @@ Common arguments: exists). Multiple --config options may be used. Can be set to `-` to read config from stdin. -d PATH, --datadir PATH, --data-dir PATH - Path to directory with historical backtesting data. + Path to the base directory of the exchange with + historical backtesting data. To see futures data, use + trading-mode additionally. --userdir PATH, --user-data-dir PATH Path to userdata directory. diff --git a/freqtrade/commands/cli_options.py b/freqtrade/commands/cli_options.py index 9620be7ab..f05907808 100755 --- a/freqtrade/commands/cli_options.py +++ b/freqtrade/commands/cli_options.py @@ -83,7 +83,8 @@ AVAILABLE_CLI_OPTIONS = { "-d", "--datadir", "--data-dir", - help="Path to directory with historical backtesting data.", + help="Path to the base directory of the exchange with historical backtesting data. " + "To see futures data, use trading-mode additionally.", metavar="PATH", ), "user_data_dir": Arg(