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

Improve documentation, add "can_short"

Browse Source
This commit is contained in:
Matthias
2022-03-12 07:16:31 +01:00
parent 6a80c0f030
commit e51a1e1b20
2 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/strategy-customization.md
View File

@@ -233,6 +233,7 @@ def populate_buy_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
Short-entries can be created by setting `enter_short` (corresponds to `enter_long` for long trades).
The `enter_tag` column remains identical.
Short-trades need to be supported by your exchange and market configuration!
Please make sure to set [`can_short`]() appropriately on your strategy if you intend to short.
```python
def populate_buy_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
@@ -388,6 +389,12 @@ Please note that the same buy/sell signals may work well with one timeframe, but
This setting is accessible within the strategy methods as the `self.timeframe` attribute.
### Can short
To use short signals in futures markets, you will have to let us know to do so by setting `can_short=True`.
Strategies which enable this will fail to load on spot markets.
Disabling of this will have short signals ignored (also in futures markets).
### Metadata dict
The metadata-dict (available for `populate_buy_trend`, `populate_sell_trend`, `populate_indicators`) contains additional information.