Skip to content

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

Conversation

JoLo90
Copy link
Contributor

@JoLo90 JoLo90 commented Jan 7, 2022

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.

  • Closes pvlib#1367
  • I am familiar with the contributing guidelines
  • Updates entries to docs/sphinx/source/api.rst 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`).
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels and Milestone are assigned to the Pull Request and linked Issue.

@kandersolar kandersolar added this to the 0.9.1 milestone Jan 7, 2022
Copy link
Member

@kandersolar kandersolar left a 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

Copy link
Member

@AdamRJensen AdamRJensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@JoLo90 JoLo90 closed this Jan 7, 2022
@JoLo90 JoLo90 reopened this Jan 7, 2022
@JoLo90 JoLo90 marked this pull request as ready for review January 7, 2022 13:50
Copy link
Member

@cwhanse cwhanse left a 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.

@cwhanse
Copy link
Member

cwhanse commented Jan 13, 2022

@pvlib/pvlib-maintainer I will merge tomorrow unless additional comments are made.

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

Successfully merging this pull request may close these issues.

4 participants