Skip to content

Fix minor typos in get_solcast_ iotools functions #2946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AdamRJensen wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −5
Open

Fix minor typos in get_solcast_ iotools functions #2946

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79466df
Add missing space in get_solcast_live code example
AdamRJensen Nov 15, 2026
f8e5909
Fix more doc typos
AdamRJensen Nov 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions pvlib/iotools/solcast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ def get_solcast_historic(
Last day of the requested period.
Must include one of ``end`` or ``duration``.
duration : optional, ISO 8601 compliant duration
Must include either ``end`` or ``duration``.
Must include either ``end`` or ``duration``.
ISO 8601 compliant duration for the historic data,
like "P1D" for one day of data.
Must be within 31 days of ``start``.
Expand Down Expand Up @@ -349,7 +349,7 @@ def get_solcast_live(
>>> df, meta = pvlib.iotools.solcast.get_solcast_live(
>>> latitude=-33.856784,
>>> longitude=151.215297,
>>> api_key="your-key"
>>> api_key="your-key"
>>> )

you can pass any of the parameters listed in the API docs, like
Expand All @@ -363,7 +363,7 @@ def get_solcast_live(
>>> )

use ``map_variables=False`` to avoid converting the data
to PVLib's conventions.
to pvlib's conventions.

>>> df, meta = pvlib.iotools.solcast.get_solcast_live(
>>> latitude=-33.856784,
Expand Down Expand Up @@ -440,7 +440,7 @@ def _get_solcast(
Parameters
----------
endpoint : str
one of Solcast API endpoint:
one of Solcast API endpoints:
- live/radiation_and_weather
- forecast/radiation_and_weather
- historic/radiation_and_weather
Expand All @@ -462,7 +462,7 @@ def _get_solcast(

References
----------
.. [1] `register <https://toolkit.solcast.com.au/register>`
.. [1] `register <https://toolkit.solcast.com.au/register>`_
"""

response = requests.get(
Expand Down
Loading