Skip to content

Standardize diffuse irradiance component names and descriptions in docstrings#2827

Open
cbcrespo wants to merge 2 commits into
pvlib:mainfrom
cbcrespo:diffuse-components-docstrings
Open

Standardize diffuse irradiance component names and descriptions in docstrings#2827
cbcrespo wants to merge 2 commits into
pvlib:mainfrom
cbcrespo:diffuse-components-docstrings

Conversation

@cbcrespo

Copy link
Copy Markdown
Contributor
  • Closes #xxxx Addresses this comment
  • 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 in docs/sphinx/source/whatsnew for 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`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

As pointed out by @cwhanse here, there were previously some discrepancies between the docstring names and definitions of different diffuse irradiance components between different functions. This PR aims to standardize those names and definitions.

Some functions were not addressed in this PR as they were already addressed in their own PRs:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant