Skip to content

Closes #423 total_irrad docstring #425

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

Merged
merged 5 commits into from
Feb 13, 2018
Merged

Closes #423 total_irrad docstring #425

merged 5 commits into from
Feb 13, 2018

Conversation

cwhanse
Copy link
Member

@cwhanse cwhanse commented Feb 12, 2018

pvlib python pull request guidelines

Thank you for your contribution to pvlib python!

You may submit a pull request with your code at any stage of completion, however, before the code can be merged the following items must be addressed:

  • Closes irradiance.total_irrad signature is incorrect #423
  • Fully tested. Added and/or modified tests to ensure correct behavior for all reasonable inputs. Tests must pass on the TravisCI and Appveyor testing services.
  • Code quality and style is sufficient. Passes git diff upstream/master -u -- "*.py" | flake8 --diff and/or landscape.io linting service.
  • New code is fully documented. Includes sphinx/numpydoc compliant docstrings and comments in the code where necessary.
  • Updates entries to docs/sphinx/source/api.rst for API changes.
  • Adds description and name entries in the appropriate docs/sphinx/source/whatsnew file for all changes.

Please don't hesitate to ask for help if you're unsure of how to accomplish any of the above. You may delete all of these instructions except for the list above.

Brief description of the problem and proposed solution (if not already fully described in the issue linked to above):

@cwhanse
Copy link
Member Author

cwhanse commented Feb 12, 2018

Done I think.

@wholmgren wholmgren added this to the 0.5.2 milestone Feb 12, 2018
Copy link
Member

@wholmgren wholmgren 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 except for the typo.

@@ -294,13 +294,20 @@ def total_irrad(surface_tilt, surface_azimuth,
model='isotropic',
model_perez='allsitescomposite1990', **kwargs):
r"""
Determine diffuse irradiance from the sky on a tilted surface.
Determine total in-plane irradiance and it's beam, sky diffuse and ground
Copy link
Member

Choose a reason for hiding this comment

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

its, not it's.

@cwhanse
Copy link
Member Author

cwhanse commented Feb 13, 2018

I knew that :)

@wholmgren
Copy link
Member

Yes, of course, I'm sure it was intended to test the reviewers -- thanks!

@wholmgren wholmgren merged commit 8a4aaca into pvlib:master Feb 13, 2018
@@ -16,6 +16,7 @@ Bug fixes
* fixed redeclaration of test_simplified_solis_series_elevation (:issue:`387`)
* physicaliam now returns a Series if called with a Series as an
argument. (:issue:`397`)
* corrected docstring for irradiance.total_irrad (:issue: '423')
Copy link
Member

Choose a reason for hiding this comment

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

pls change single quotes around #423 to backticks

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.

3 participants