Improve doc wording around informative pair candle types

closes #7792
This commit is contained in:
Matthias 2022-11-25 14:20:41 +01:00
parent b8d1862ca8
commit 048119ad3d

View File

@ -446,15 +446,17 @@ A full sample can be found [in the DataProvider section](#complete-data-provider
??? Note "Alternative candle types" ??? Note "Alternative candle types"
Informative_pairs can also provide a 3rd tuple element defining the candle type explicitly. Informative_pairs can also provide a 3rd tuple element defining the candle type explicitly.
Availability of alternative candle-types will depend on the trading-mode and the exchange. Details about this can be found in the exchange documentation. Availability of alternative candle-types will depend on the trading-mode and the exchange.
In general, spot pairs cannot be used in futures markets, and futures candles can't be used as informative pairs for spot bots.
Details about this may vary, if they do, this can be found in the exchange documentation.
``` python ``` python
def informative_pairs(self): def informative_pairs(self):
return [ return [
("ETH/USDT", "5m", ""), # Uses default candletype, depends on trading_mode ("ETH/USDT", "5m", ""), # Uses default candletype, depends on trading_mode (recommended)
("ETH/USDT", "5m", "spot"), # Forces usage of spot candles ("ETH/USDT", "5m", "spot"), # Forces usage of spot candles (only valid for bots running on spot markets).
("BTC/TUSD", "15m", "futures"), # Uses futures candles ("BTC/TUSD", "15m", "futures"), # Uses futures candles (only bots with `trading_mode=futures`)
("BTC/TUSD", "15m", "mark"), # Uses mark candles ("BTC/TUSD", "15m", "mark"), # Uses mark candles (only bots with `trading_mode=futures`)
] ]
``` ```
*** ***