pvlib-python icon indicating copy to clipboard operation
pvlib-python copied to clipboard

[DOC]: params & units guidelines in contributing page

Open echedey-ls opened this issue 1 year ago • 0 comments

Improve "contributing" guidelines on how to find parameter names and their units.

  • [x] Closes #2205
  • [x] I am familiar with the contributing guidelines
  • [ ] 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 (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

In coordination with style decided in #2234.

Makes two changes to index pages of functions, to avoid being too verbose and a typo.

Links

  • https://pvlib-python--2248.org.readthedocs.build/en/2248/contributing/style_guide.html#parameter-names-and-units

echedey-ls avatar Oct 09 '24 15:10 echedey-ls