From c3206d72cbed5c1b24ba91cd8c9bd31dfbf4a7be Mon Sep 17 00:00:00 2001 From: hroff-1902 Date: Mon, 25 May 2020 22:49:57 +0300 Subject: [PATCH] Adjust docstring for IPairList.gen_pairlist() --- freqtrade/pairlist/IPairList.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/freqtrade/pairlist/IPairList.py b/freqtrade/pairlist/IPairList.py index 0a291fdf7..f48a7dcfd 100644 --- a/freqtrade/pairlist/IPairList.py +++ b/freqtrade/pairlist/IPairList.py @@ -93,7 +93,15 @@ class IPairList(ABC): def gen_pairlist(self, cached_pairlist: List[str], tickers: Dict) -> List[str]: """ - Generate the pairlist + Generate the pairlist. + + This method is called once by the pairlistmanager in the refresh_pairlist() + method to supply the starting pairlist for the chain of the Pairlist Handlers. + Pairlist Filters (those Pairlist Handlers that cannot be used at the first + position in the chain) shall not override this base implementation -- + it will raise the exception if a Pairlist Handler is used at the first + position in the chain. + :param cached_pairlist: Previously generated pairlist (cached) :param tickers: Tickers (from exchange.get_tickers()). :return: List of pairs