adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1693 from freqtrade/fix/doc_formatting

Browse Source 
Fix Documentation Boxes
This commit is contained in:
Misagh
2019-03-23 20:05:27 +01:00
committed by GitHub
parent 6312d785d8 0dc96210b6
commit e0775546f6
5 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/bot-optimization.md
View File

@@ -47,7 +47,7 @@ python3 ./freqtrade/main.py --strategy AwesomeStrategy
**For the following section we will use the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py) **For the following section we will use the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py)
file as reference.** file as reference.**
!!! Note: Strategies and Backtesting !!! Note Strategies and Backtesting
To avoid problems and unexpected differences between Backtesting and dry/live modes, please be aware To avoid problems and unexpected differences between Backtesting and dry/live modes, please be aware
that during backtesting the full time-interval is passed to the `populate_*()` methods at once. that during backtesting the full time-interval is passed to the `populate_*()` methods at once.
It is therefore best to use vectorized operations (across the whole dataframe, not loops) and It is therefore best to use vectorized operations (across the whole dataframe, not loops) and
@@ -250,17 +250,17 @@ class Awesomestrategy(IStrategy):
self.cust_info[metadata["pair"]["crosstime"] = 1 self.cust_info[metadata["pair"]["crosstime"] = 1
``` ```
!!! Warning: !!! Warning
The data is not persisted after a bot-restart (or config-reload). Also, the amount of data should be kept smallish (no DataFrames and such), otherwise the bot will start to consume a lot of memory and eventually run out of memory and crash. The data is not persisted after a bot-restart (or config-reload). Also, the amount of data should be kept smallish (no DataFrames and such), otherwise the bot will start to consume a lot of memory and eventually run out of memory and crash.
!!! Note: !!! Note
If the data is pair-specific, make sure to use pair as one of the keys in the dictionary. If the data is pair-specific, make sure to use pair as one of the keys in the dictionary.
### Additional data (DataProvider) ### Additional data (DataProvider)
The strategy provides access to the `DataProvider`. This allows you to get additional data to use in your strategy. The strategy provides access to the `DataProvider`. This allows you to get additional data to use in your strategy.
!!!Note: !!! Note
The DataProvier is currently not available during backtesting / hyperopt, but this is planned for the future. The DataProvier is currently not available during backtesting / hyperopt, but this is planned for the future.
All methods return `None` in case of failure (do not raise an exception). All methods return `None` in case of failure (do not raise an exception).
@@ -288,7 +288,7 @@ if self.dp:
ticker_interval='1h') ticker_interval='1h')
``` ```
!!! Warning: Warning about backtesting !!! Warning Warning about backtesting
Be carefull when using dataprovider in backtesting. `historic_ohlcv()` provides the full time-range in one go, Be carefull when using dataprovider in backtesting. `historic_ohlcv()` provides the full time-range in one go,
so please be aware of it and make sure to not "look into the future" to avoid surprises when running in dry/live mode). so please be aware of it and make sure to not "look into the future" to avoid surprises when running in dry/live mode).
@@ -317,7 +317,7 @@ def informative_pairs(self):
] ]
``` ```
!!! Warning: !!! Warning
As these pairs will be refreshed as part of the regular whitelist refresh, it's best to keep this list short. As these pairs will be refreshed as part of the regular whitelist refresh, it's best to keep this list short.
All intervals and all pairs can be specified as long as they are available (and active) on the used exchange. All intervals and all pairs can be specified as long as they are available (and active) on the used exchange.
It is however better to use resampling to longer time-intervals when possible It is however better to use resampling to longer time-intervals when possible
@@ -327,7 +327,7 @@ def informative_pairs(self):
The strategy provides access to the `Wallets` object. This contains the current balances on the exchange. The strategy provides access to the `Wallets` object. This contains the current balances on the exchange.
!!!NOTE: !!! Note
Wallets is not available during backtesting / hyperopt. Wallets is not available during backtesting / hyperopt.
Please always check if `Wallets` is available to avoid failures during backtesting. Please always check if `Wallets` is available to avoid failures during backtesting.

4
docs/hyperopt.md
View File

@@ -293,8 +293,8 @@ You can overwrite position stacking in the configuration by explicitly setting `
Enabling the market-position for hyperopt is currently not possible. Enabling the market-position for hyperopt is currently not possible.
!!! Note: !!! Note
Dry/live runs will **NOT** use position stacking - therefore it does make sense to also validate the strategy without this as it's closer to reality. Dry/live runs will **NOT** use position stacking - therefore it does make sense to also validate the strategy without this as it's closer to reality.
## Next Step ## Next Step

6
docs/installation.md
View File

@@ -437,9 +437,9 @@ when it changes.
The `freqtrade.service.watchdog` file contains an example of the service unit configuration file which uses systemd The `freqtrade.service.watchdog` file contains an example of the service unit configuration file which uses systemd
as the watchdog. as the watchdog.
!!! Note: !!! Note
The sd_notify communication between the bot and the systemd service manager will not work if the bot runs in a The sd_notify communication between the bot and the systemd service manager will not work if the bot runs in a
Docker container. Docker container.
------ ------

4
docs/sql_cheatsheet.md
View File

@@ -65,11 +65,11 @@ SELECT * FROM trades;
## Fix trade still open after a manual sell on the exchange ## Fix trade still open after a manual sell on the exchange
!!! Warning: !!! Warning
Manually selling on the exchange should not be done by default, since the bot does not detect this and will try to sell anyway. Manually selling on the exchange should not be done by default, since the bot does not detect this and will try to sell anyway.
/foresell <tradeid> should accomplish the same thing. /foresell <tradeid> should accomplish the same thing.
!!! Note: !!! Note
This should not be necessary after /forcesell, as forcesell orders are closed automatically by the bot on the next iteration. This should not be necessary after /forcesell, as forcesell orders are closed automatically by the bot on the next iteration.
```sql ```sql

4
docs/telegram-usage.md
View File

@@ -55,8 +55,8 @@ Once all positions are sold, run `/stop` to completely stop the bot.
`/reload_conf` resets "max_open_trades" to the value set in the configuration and resets this command. `/reload_conf` resets "max_open_trades" to the value set in the configuration and resets this command.
!!! warning: !!! warning
The stop-buy signal is ONLY active while the bot is running, and is not persisted anyway, so restarting the bot will cause this to reset. The stop-buy signal is ONLY active while the bot is running, and is not persisted anyway, so restarting the bot will cause this to reset.
### /status ### /status