Skip to content
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

Docstring cleanup for pvlib.ivtools #1765

Merged
merged 3 commits into from
Jun 9, 2023

Conversation

kandersolar
Copy link
Member

  • [ ] Closes #xxxx
  • I am familiar with the contributing guidelines
  • [ ] Tests added
  • [ ] Updates entries in docs/sphinx/source/reference 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 (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

This PR improves the docstrings for the functions in pvlib.ivtools:

  • add DOI links
  • fix broken sphinx rendering of Raises sections and a bulleted list
  • fixes a misplaced parenthesis in the math of sde.fit_sandia_simple

@kandersolar kandersolar added this to the 0.10.0 milestone Jun 8, 2023
@kandersolar kandersolar mentioned this pull request Jun 8, 2023
@kandersolar kandersolar merged commit 311781d into pvlib:main Jun 9, 2023
29 checks passed
@kandersolar kandersolar deleted the docstring_log branch June 9, 2023 20:05
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.

None yet

2 participants