CTYPTO/freqtrade
1
0
Fork 0
mirror of https://github.com/freqtrade/freqtrade.git synced 2025-11-29 08:33:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improved help wording

Browse Source
This commit is contained in:
Matthias
2025-08-17 15:15:55 +02:00
parent a00a5e52c4
commit e34ea393d9
7 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/commands/backtesting-analysis.md
View File

@@ -3,7 +3,7 @@ usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE]
[-V] [-c PATH] [-d PATH] [-V] [-c PATH] [-d PATH]
[--userdir PATH] [--userdir PATH]
[--backtest-filename PATH] [--backtest-filename PATH]
[--export-directory PATH] [--backtest-directory PATH]
[--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]] [--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]]
[--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]] [--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]]
[--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]] [--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]]
@@ -19,9 +19,9 @@ options:
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. 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` as base directory.
--export-directory PATH, --backtest-directory PATH --backtest-directory PATH, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...] --analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]

7
docs/commands/backtesting-show.md
View File

@@ -2,7 +2,8 @@
usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V] usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-c PATH] [-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[--backtest-filename 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} ...]] [--breakdown {day,week,month,year} [{day,week,month,year} ...]]
options: options:
@@ -11,9 +12,9 @@ options:
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. 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` as base directory.
--export-directory PATH, --backtest-directory PATH --backtest-directory PATH, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--show-pair-list Show backtesting pairlist sorted by profit. --show-pair-list Show backtesting pairlist sorted by profit.

6
docs/commands/backtesting.md
View File

@@ -15,7 +15,7 @@ usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
[--export {none,trades,signals}] [--export {none,trades,signals}]
[--backtest-filename PATH] [--backtest-filename PATH]
[--export-directory PATH] [--backtest-directory PATH]
[--breakdown {day,week,month,year} [{day,week,month,year} ...]] [--breakdown {day,week,month,year} [{day,week,month,year} ...]]
[--cache {none,day,week,month}] [--cache {none,day,week,month}]
[--freqai-backtest-live-models] [--notes TEXT] [--freqai-backtest-live-models] [--notes TEXT]
@@ -66,9 +66,9 @@ options:
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. 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` as base directory.
--export-directory PATH, --backtest-directory PATH --backtest-directory PATH, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--breakdown {day,week,month,year} [{day,week,month,year} ...] --breakdown {day,week,month,year} [{day,week,month,year} ...]

6
docs/commands/lookahead-analysis.md
View File

@@ -16,7 +16,7 @@ usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE]
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
[--export {none,trades,signals}] [--export {none,trades,signals}]
[--backtest-filename PATH] [--backtest-filename PATH]
[--export-directory PATH] [--backtest-directory PATH]
[--freqai-backtest-live-models] [--freqai-backtest-live-models]
[--minimum-trade-amount INT] [--minimum-trade-amount INT]
[--targeted-trade-amount INT] [--targeted-trade-amount INT]
@@ -65,9 +65,9 @@ options:
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. 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` as base directory.
--export-directory PATH, --backtest-directory PATH --backtest-directory PATH, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--freqai-backtest-live-models --freqai-backtest-live-models

2
docs/commands/plot-dataframe.md
View File

@@ -42,7 +42,7 @@ options:
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. 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` as base directory.
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.

2
docs/commands/plot-profit.md
View File

@@ -23,7 +23,7 @@ options:
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. 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` as base directory.
--db-url PATH Override trades database URL, this is useful in custom --db-url PATH Override trades database URL, this is useful in custom
deployments (default: `sqlite:///tradesv3.sqlite` for deployments (default: `sqlite:///tradesv3.sqlite` for

4
freqtrade/commands/cli_options.py
View File

@@ -210,8 +210,8 @@ AVAILABLE_CLI_OPTIONS = {
choices=constants.EXPORT_OPTIONS, choices=constants.EXPORT_OPTIONS,
), ),
"exportdirectory": Arg( "exportdirectory": Arg(
"--export-directory",
"--backtest-directory", "--backtest-directory",
"--export-directory",
help="Directory to use for backtest results. " help="Directory to use for backtest results. "
"Example: `--export-directory=user_data/backtest_results/`. ", "Example: `--export-directory=user_data/backtest_results/`. ",
metavar="PATH", metavar="PATH",
@@ -221,7 +221,7 @@ AVAILABLE_CLI_OPTIONS = {
"--export-filename", "--export-filename",
help="Use this filename for backtest results." help="Use this filename for backtest results."
"Example: `--backtest-filename=backtest_results_2020-09-27_16-20-48.json`. " "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", metavar="PATH",
), ),
"disableparamexport": Arg( "disableparamexport": Arg(