Skip to content

Commit b518d66

Browse files
committed
chore: improve docstring for get_Trades_proxy.
1 parent 2ba59ce commit b518d66

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

freqtrade/persistence/trade_model.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1802,11 +1802,15 @@ def get_trades_proxy(
18021802
close_date: datetime | None = None,
18031803
) -> list["LocalTrade"]:
18041804
"""
1805-
Helper function to query Trades.j
1805+
Helper function to query Trades.
18061806
Returns a List of trades, filtered on the parameters given.
18071807
In live mode, converts the filter to a database query and returns all rows
18081808
In Backtest mode, uses filters on Trade.bt_trades to get the result.
1809-
1809+
:param pair: Filter by pair
1810+
:param is_open: Filter by open/closed status
1811+
:param open_date: Filter by open_date (filters via trade.open_date > input)
1812+
:param close_date: Filter by close_date (filters via trade.close_date > input)
1813+
and will implicitly only return closed trades.
18101814
:return: unsorted List[Trade]
18111815
"""
18121816
if Trade.use_db:

0 commit comments

Comments
 (0)