Skip to content

[DOC] pvsystem.singlediode math rendering #971

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 6 commits into from
Jun 10, 2020

Conversation

kandersolar
Copy link
Member

@kandersolar kandersolar commented May 22, 2020

  • Closes #xxxx
  • I am familiar with the contributing guidelines
  • Tests added
  • 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`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • 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.

Per @mikofski's suggestion here: #967 (review)

The Returns section still doesn't look great, but I'd rather not deal with that here if that's okay.

Built version: https://pvlib-python--971.org.readthedocs.build/en/971/generated/pvlib.pvsystem.singlediode.html

@kandersolar kandersolar changed the title pvsystem.singlediode math rendering [DOC] pvsystem.singlediode math rendering May 22, 2020
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 @kanderso-nrel much improved.

@cwhanse
Copy link
Member

cwhanse commented May 22, 2020

Also @kanderso-nrel it would be worth adding a "See also" section to the docstring if you are so inclined, pointing to the calcparams_desoto, calcparams_pvsyst and calcparams_cec functions.

@kandersolar
Copy link
Member Author

@cwhanse There was a "See also" section already, way at the bottom. I added the missing functions to it. Maybe move it to above the references?

@cwhanse
Copy link
Member

cwhanse commented May 24, 2020

@cwhanse There was a "See also" section already, way at the bottom. I added the missing functions to it. Maybe move it to above the references?

According to the numpy guide the order should be See Also, Notes, References, Examples.

@cwhanse cwhanse merged commit 3183cc9 into pvlib:master Jun 10, 2020
@cwhanse
Copy link
Member

cwhanse commented Jun 10, 2020

Thanks @kanderso-nrel

@kandersolar kandersolar deleted the singlediode_docstring branch June 10, 2020 22:09
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