Skip to content

Commit fc9b4d5

Browse files
Fix variable name max_nr_orders to max_nr_trades for trades requests (#48)
Typo fix
2 parents ac785b8 + 201cacd commit fc9b4d5

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616

1717
## Bug Fixes
1818

19-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
19+
- Fix variable name `max_nr_orders` to `max_nr_trades` for trades requests

src/frequenz/client/electricity_trading/_client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -728,7 +728,7 @@ async def list_gridpool_trades( # pylint: disable=too-many-arguments
728728
market_side: MarketSide | None = None,
729729
delivery_period: DeliveryPeriod | None = None,
730730
delivery_area: DeliveryArea | None = None,
731-
max_nr_orders: int | None = None,
731+
max_nr_trades: int | None = None,
732732
page_token: str | None = None,
733733
) -> list[Trade]:
734734
"""
@@ -741,7 +741,7 @@ async def list_gridpool_trades( # pylint: disable=too-many-arguments
741741
market_side: The side of the market to filter by.
742742
delivery_period: The delivery period to filter by.
743743
delivery_area: The delivery area to filter by.
744-
max_nr_orders: The maximum number of orders to return.
744+
max_nr_trades: The maximum number of trades to return.
745745
page_token: The page token to use for pagination.
746746
747747
Returns:
@@ -759,7 +759,7 @@ async def list_gridpool_trades( # pylint: disable=too-many-arguments
759759
)
760760

761761
pagination_params = PaginationParams(
762-
page_size=max_nr_orders,
762+
page_size=max_nr_trades,
763763
page_token=page_token,
764764
)
765765

@@ -787,7 +787,7 @@ async def list_public_trades( # pylint: disable=too-many-arguments
787787
delivery_period: DeliveryPeriod | None = None,
788788
buy_delivery_area: DeliveryArea | None = None,
789789
sell_delivery_area: DeliveryArea | None = None,
790-
max_nr_orders: int | None = None,
790+
max_nr_trades: int | None = None,
791791
page_token: str | None = None,
792792
) -> list[PublicTrade]:
793793
"""
@@ -798,7 +798,7 @@ async def list_public_trades( # pylint: disable=too-many-arguments
798798
delivery_period: The delivery period to filter by.
799799
buy_delivery_area: The buy delivery area to filter by.
800800
sell_delivery_area: The sell delivery area to filter by.
801-
max_nr_orders: The maximum number of orders to return.
801+
max_nr_trades: The maximum number of trades to return.
802802
page_token: The page token to use for pagination.
803803
804804
Returns:
@@ -815,7 +815,7 @@ async def list_public_trades( # pylint: disable=too-many-arguments
815815
)
816816

817817
pagination_params = PaginationParams(
818-
page_size=max_nr_orders,
818+
page_size=max_nr_trades,
819819
page_token=page_token,
820820
)
821821

0 commit comments

Comments
 (0)