-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Improve docstring in IEC 61853 module temperature model #840
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
Conversation
@cwhanse Could you check this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Optional: perhaps add the subscript indicator, and clarify that equation 5 refers to [1].
Co-Authored-By: Cliff Hansen <[email protected]>
Just to confirm... Are you happy with the way the docstring is rendered? See the |
Sorry I don't see that link and I don't know how the doc string looks. :( |
Thanks, yes, not nice. I would remove the three underscores tomorrow unless Cliff objects. Also, the units for u1 and u_v in pvsyst_cell look suspicious... |
@adriesse You might also want to use sphinx's |
I understand, and I appreciate the hints all around, but this simple clarification is again turning into way more than I bargained for. |
docs/sphinx/source/api.rst
for API changes.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`
).