Skip to content

Document the URL default get_acis_station_data actually uses - #2950

Merged
cwhanse merged 3 commits into
pvlib:mainfrom
dylanpulver:doc/acis-station-data-url-default
Nov 19, 2026
Merged

cwhanse merged 3 commits into
pvlib:mainfrom
dylanpulver:doc/acis-station-data-url-default

Conversation

@dylanpulver

Copy link
Copy Markdown
Contributor

get_acis_station_data has url="https://data.rcc-acis.org/StnData" in its signature, the station endpoint, and its docstring documents the GridData endpoint instead.

The three sibling readers get_acis_prism, get_acis_nrcc and get_acis_mpe all default to GridData and document it correctly, so the entry looks copied across from them when the station reader was added in #1767.

Docstrings only, no behaviour change.

  • Closes #xxxx
  • I am familiar with the contributing guidelines
  • I attest that all AI-generated material has been vetted for accuracy and is in compliance with the pvlib license
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.

The signature is url="https://data.rcc-acis.org/StnData", which is the
station endpoint, but the docstring documented the GridData endpoint.

The three sibling readers (get_acis_prism, get_acis_nrcc, get_acis_mpe)
all default to GridData and document it correctly, so the entry looks
copied across from them when the station reader was added.
@cwhanse cwhanse added this to the v0.16.2 milestone Nov 18, 2026

@cwhanse cwhanse left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A useful AI contribution, thanks!

Comment thread docs/sphinx/source/whatsnew/v0.16.2.rst Outdated
* :py:func:`pvlib.scaling.wvm` no longer returns all NaNs when ``positions``
contains a single site (:issue:`2895`, :pull:`2896`)
* Document the URL default :py:func:`pvlib.iotools.get_acis_station_data` actually
uses. Its docstring named the GridData endpoint; the signature uses StnData.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
uses. Its docstring named the GridData endpoint; the signature uses StnData.
uses. Its docstring named the GridData endpoint; should be StnData.

@cwhanse
cwhanse merged commit c5a4fee into pvlib:main Nov 19, 2026
26 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants