Add to custom_sell() documentation

- Flesh out infos about return type 
- give quick example at beginning to get reader in right mindset what this does and why it's useful
This commit is contained in:
JoeSchr 2021-04-29 12:49:51 +02:00 committed by GitHub
parent bb115154eb
commit cf839e36f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions

View File

@ -44,7 +44,11 @@ class AwesomeStrategy(IStrategy):
## Custom sell signal
It is possible to define custom sell signals. This is very useful when we need to customize sell conditions for each individual trade, or if you need the trade profit to take the sell decision.
It is possible to define custom sell signals, indicating that specified position should be sold. This is very useful when we need to customize sell conditions for each individual trade, or if you need the trade profit to take the sell decision.
For example you could implement a stoploss relative to candle when trade was opened, or a custom 1:2 risk-reward ROI.
!!! Note Returning a `string` or `True` from this method is equal to setting sell signal on a candle at specified time. This method is not called when sell signal is set. `string` max length is 64 characters. Exceeding this limit will raise `OperationalException`.
An example of how we can use different indicators depending on the current profit and also sell trades that were open longer than one day: