Skip to content

Commit

Permalink
Update docs to make regime optional
Browse files Browse the repository at this point in the history
  • Loading branch information
braddf committed Sep 10, 2024
1 parent 45bcc21 commit 8672d80
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/gsp.py
Original file line number Diff line number Diff line change
Expand Up @@ -241,15 +241,16 @@ def get_truths_for_all_gsps(
Setting the _regime_ parameter to _day-after_ includes
the previous day's truth values for the GSPs.
If _regime_ is not specified, the parameter defaults to _in-day_.
If _regime_ is not specified, the parameter defaults to None and returns PV Live Updated
values where available, falling back to available PV Live Estimated values.
If _compact_ is set to true, the response will be a list of GSPGenerations objects.
This return object is significantly smaller, but less readable.
#### Parameters
- **regime**: can choose __in-day__ or __day-after__
- **start_datetime_utc**: optional start datetime for the query.
- **end_datetime_utc**: optional end datetime for the query.
- **regime**: (optional) can choose __in-day__ or __day-after__
- **start_datetime_utc**: (optional) start datetime for the query.
- **end_datetime_utc**: (optional) end datetime for the query.
"""
logger.info(f"Get PV Live estimates values for all gsp id and regime {regime} for user {user}")

Expand Down

0 comments on commit 8672d80

Please sign in to comment.