Fix some documentation errors
This commit is contained in:
parent
03e60b9ea4
commit
0488525888
@ -34,9 +34,9 @@ optional arguments:
|
|||||||
Multiple --config options may be used. Can be set to
|
Multiple --config options may be used. Can be set to
|
||||||
`-` to read config from stdin.
|
`-` to read config from stdin.
|
||||||
-d PATH, --datadir PATH
|
-d PATH, --datadir PATH
|
||||||
Path to backtest data.
|
Path to directory with historical backtesting data.
|
||||||
--userdir PATH, --user-data-dir PATH
|
--userdir PATH, --user-data-dir PATH
|
||||||
Path to Userdata Directory.
|
Path to userdata directory.
|
||||||
-s NAME, --strategy NAME
|
-s NAME, --strategy NAME
|
||||||
Specify strategy class name (default:
|
Specify strategy class name (default:
|
||||||
`DefaultStrategy`).
|
`DefaultStrategy`).
|
||||||
@ -92,19 +92,21 @@ See more details on this technique with examples in the documentation page on
|
|||||||
Freqtrade allows the creation of a user-data directory using `freqtrade create-userdir --userdir someDirectory`.
|
Freqtrade allows the creation of a user-data directory using `freqtrade create-userdir --userdir someDirectory`.
|
||||||
This directory will look as follows:
|
This directory will look as follows:
|
||||||
|
|
||||||
|
```
|
||||||
user_data/
|
user_data/
|
||||||
├── backtest_results
|
├── backtest_results
|
||||||
├── data
|
├── data
|
||||||
├── hyperopts
|
├── hyperopts
|
||||||
├── plot
|
├── plot
|
||||||
└── strategies
|
└── strategies
|
||||||
|
```
|
||||||
|
|
||||||
You can add the entry "user_data_dir" to your configuration, to always point your bot to this folder.
|
You can add the entry "user_data_dir" setting to your configuration, to always point your bot to this directory.
|
||||||
Alternatively, pass in `--userdir` to every command.
|
Alternatively, pass in `--userdir` to every command.
|
||||||
|
|
||||||
This directory should contain your custom strategies, custom hyperopts, backtest data (downloaded using either backtesting or the download script) and plot outputs.
|
This directory should contain your custom strategies, custom hyperopts and hyperopt loss functions, backtesting historical data (downloaded using either backtesting command or the download script) and plot outputs.
|
||||||
|
|
||||||
It is reccomendet to use version control to keep track of changes to your strategies.
|
It is recommended to use version control to keep track of changes to your strategies.
|
||||||
|
|
||||||
### How to use **--strategy**?
|
### How to use **--strategy**?
|
||||||
|
|
||||||
|
@ -55,12 +55,12 @@ AVAILABLE_CLI_OPTIONS = {
|
|||||||
),
|
),
|
||||||
"datadir": Arg(
|
"datadir": Arg(
|
||||||
'-d', '--datadir',
|
'-d', '--datadir',
|
||||||
help='Path to backtest data.',
|
help='Path to directory with historical backtesting data.',
|
||||||
metavar='PATH',
|
metavar='PATH',
|
||||||
),
|
),
|
||||||
"user_data_dir": Arg(
|
"user_data_dir": Arg(
|
||||||
'--userdir', '--user-data-dir',
|
'--userdir', '--user-data-dir',
|
||||||
help='Path to Userdata Directory.',
|
help='Path to userdata directory.',
|
||||||
metavar='PATH',
|
metavar='PATH',
|
||||||
),
|
),
|
||||||
# Main options
|
# Main options
|
||||||
|
Loading…
Reference in New Issue
Block a user