docs: fix parameter name mismatches in docstrings#2804
Conversation
- pvsystem.py: `aoi_model` -> `iam_model` in PVSystem.get_iam and Array.get_iam (signature parameter is `iam_model`) - solarposition.py: `time` -> `times` in sun_rise_set_transit_ephem - irradiance.py: _liujordan documented a nonexistent `pressure` parameter; replace with the actual `airmass` parameter - bifacial/infinite_sheds.py: remove duplicated stale Parameters block in _poa_sky_diffuse_pv (listed `f_x` and `npoints` which are not parameters of this function)
Hey @eeshsaxena! 🎉Thanks for opening your first pull request! We appreciate your If AI is used for any portion of this PR, you must vet the content |
|
Thanks @eeshsaxena. The changes LGTM. I think a whatsnew note is not really needed here, but (if you like) please do push another commit to list yourself as a contributor in https://github.com/pvlib/pvlib-python/blob/main/docs/sphinx/source/whatsnew/v0.15.3.rst The readthedocs CI failure is unrelated and can be ignored here. |
|
Thanks @kandersolar! Added myself to the v0.15.3 contributors list. |
Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>
|
Thanks @eeshsaxena! |
|
Wondering how did you spot these mismatchs @eeshsaxena ? Was it by running the codebase through some LLM or do you happen to use any more sophisticated tool? |
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).Fixes several docstrings where the documented parameter name does not match the actual function signature:
pvlib/pvsystem.pyPVSystem.get_iam,Array.get_iamaoi_modeliam_modelpvlib/solarposition.pysun_rise_set_transit_ephemtimetimespvlib/irradiance.py_liujordanpressure(not a parameter)airmass(was undocumented)pvlib/bifacial/infinite_sheds.py_poa_sky_diffuse_pvf_x,npointsdhi, gcr, surface_tiltDoc-only change, no behavior modified. Happy to add a whatsnew entry if maintainers want one for a docs-only fix - let me know which file it should go in.