Adjust docstring for IPairList.gen_pairlist()

This commit is contained in:
hroff-1902 2020-05-25 22:49:57 +03:00
parent 0e416dc4f5
commit c3206d72cb
1 changed files with 9 additions and 1 deletions

View File

@ -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