Clarify output variable mapping in calcparams_ functions #2405
Conversation
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
…_cec, and calcparams_pvsyst
cwhanse
reviewed
Mar 11, 2025
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
|
@cwhanse I've merged your suggestions into my PR branch! |
|
@MaxJackson can you add yourself as a contributor to the whatsnew file? In docs/sphinx/source/whatsnew/v0.11.3.rst I don't think we need a note about this change. |
|
Two trailing whitespaces to remove also :) |
|
@cwhanse done! |
cwhanse
approved these changes
Mar 11, 2025
There was a problem hiding this comment.
thanks @MaxJackson
And for fixing the typo in the whatsnew file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
remote-data) and Milestone are assigned to the Pull Request and linked Issue.The functions
pvsystem.calcparams_desoto,pvsystem.calcparams_cecandpvsystem.calcparams_pvsystreturn variables which are named/labeled differently than the variables in the functions themselves. This PR adds inline comments where the return variables are initialized to help clarify exactly what calculated values are being returned.