Standardize diffuse irradiance component names and descriptions in docstrings#2827
Open
cbcrespo wants to merge 4 commits into
Open
Standardize diffuse irradiance component names and descriptions in docstrings#2827cbcrespo wants to merge 4 commits into
cbcrespo wants to merge 4 commits into
Conversation
AdamRJensen
reviewed
Jul 23, 2026
| * Fixed broken ``interval`` keyword argument in the ``oedi_9068`` gallery | ||
| example; the correct parameter name is ``time_step``. (:issue:`2791`) | ||
| * Standardized diffuse component names and descriptions in the docstrings of | ||
| multiple functions in :py:mod:`pvlib.irradiance`. (:pull:`2827`) |
Member
There was a problem hiding this comment.
Suggested change
| multiple functions in :py:mod:`pvlib.irradiance`. (:pull:`2827`) | |
| multiple functions in :py:mod:`pvlib.irradiance`. | |
| (:issue:`2750`, :pull:`2827`) |
AdamRJensen
reviewed
Jul 23, 2026
AdamRJensen
left a comment
AdamRJensen
left a comment
Member
There was a problem hiding this comment.
Great work!
Could you also update the nomenclature entries?
cwhanse
approved these changes
Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #xxxxAddresses this commentTests addedUpdates entries indocs/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`).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:
isotropic: Add support for return_components to irradiance.isotropic #2787reindl: Add support for return_components to Reindl #2775get_sky_diffuse,poa_components, andget_total_irradiance: Add diffuse components support:get_sky_diffuse,poa_components, andget_total_irradiance#2800