Revise dc_ohmic_loss and dc_ohms_from_percent docstrings #2229
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RDaxini
reviewed
Sep 27, 2024
Thanks @RDaxini Co-authored-by: RDaxini <143435106+RDaxini@users.noreply.github.com>
RDaxini
approved these changes
Sep 27, 2024
|
That was a misclick. I thought I was confirming the email associated with the last commit. @pvlib/pvlib-maintainer can do a follow-on if further edits are desired. |
kandersolar
reviewed
Sep 30, 2024
|
|
||
| .. math:: | ||
|
|
||
| L = I \times R^2 |
| @@ -14,6 +14,8 @@ Enhancements | |||
|
|
|||
| Documentation | |||
| ~~~~~~~~~~~~~ | |||
| * Edited docstrings for :py:func:`~pvlib.pvsystem.dc_ohms_from_percent` and | |||
| :py:func:`~pvlib.pvsystem.dc_ohmic_loss` for clarity. (:issue:`1601`, :pull:`2229`) | |||
There was a problem hiding this comment.
should be dc_ohmic_losses, not dc_ohmic_loss
kandersolar
pushed a commit
that referenced
this pull request
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[ ] Tests added[ ] Updates entries indocs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor 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`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.#1601 points out that the calculations are elementary and referencing the PVsyst help file isn't appropriate. Being elementary, and completely explained in the docstring, obviates the need for a reference IMO.
The docstring for
dc_ohms_from_percentwas further edited to fix a few typos, adjust to recent style (explanatory Notes section), and clarify module vs. array parameters.