-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Correct cloud_cover_to_transmittance_linear documentation #1370
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Correct cloud_cover_to_transmittance_linear documentation #1370
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @JoLo90! The coverage and pytest failures can be ignored here. One suggestion below, otherwise LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this contribution, @JoLo90. Some suggested edits.
Co-authored-by: Cliff Hansen <[email protected]>
@pvlib/pvlib-maintainer I will merge tomorrow unless additional comments are made. |
Corrects the documentation of the cloud_cover_to_transmittance_linear function. The current return is documented as the ghi instead of the transmittance. The information "percentage" has been added to the cloud cover and "ratio" to the transmittance.
docs/sphinx/source/api.rst
for API changes.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`
).