Skip to content

Commit 1192df5

Browse files
committed
Add help text to delivery time filters on gridpool data endpoints
Signed-off-by: cwasicki <126617870+cwasicki@users.noreply.github.com>
1 parent 40646c7 commit 1192df5

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

src/frequenz/client/electricity_trading/cli/__main__.py

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,18 @@ def receive_public_orders( # pylint: disable=too-many-arguments
110110
@click.option("--url", required=True, type=str)
111111
@click.option("--auth_key", required=True, type=str)
112112
@click.option("--gid", required=True, type=int)
113-
@click.option("--delivery-from", default=None, type=iso)
114-
@click.option("--delivery-to", default=None, type=iso)
113+
@click.option(
114+
"--delivery-from",
115+
default=None,
116+
type=iso,
117+
help="Start timestamp (inclusive) to filter delivery start times.",
118+
)
119+
@click.option(
120+
"--delivery-to",
121+
default=None,
122+
type=iso,
123+
help="End timestamp (exclusive) to filter delivery start times.",
124+
)
115125
@click.option("--sign_secret", default=None, type=str)
116126
def receive_gridpool_trades(
117127
url: str,
@@ -139,8 +149,18 @@ def receive_gridpool_trades(
139149
@cli.command()
140150
@click.option("--url", required=True, type=str)
141151
@click.option("--auth_key", required=True, type=str)
142-
@click.option("--delivery-from", default=None, type=iso)
143-
@click.option("--delivery-to", default=None, type=iso)
152+
@click.option(
153+
"--delivery-from",
154+
default=None,
155+
type=iso,
156+
help="Start timestamp (inclusive) to filter delivery start times.",
157+
)
158+
@click.option(
159+
"--delivery-to",
160+
default=None,
161+
type=iso,
162+
help="End timestamp (exclusive) to filter delivery start times.",
163+
)
144164
@click.option("--gid", required=True, type=int)
145165
@click.option("--sign_secret", default=None, type=str)
146166
def receive_gridpool_orders(

0 commit comments

Comments
 (0)