Fix iam.martin_ruiz equation in docs #1561 - #1599
Conversation
|
I've got a doubt in the optional use of |
kandersolar
left a comment
There was a problem hiding this comment.
Looks great, thanks @echedey-ls!
I've got a doubt in the optional use of ~ in :py:func:
~pvlib.iam.martin_ruiz, I've seen some rST entries don't use it (I didn't) but all still works. Can you tell me if it's use is recommended or not?
The ~ controls whether the HTML link text will look like pvlib.iam.martin_ruiz or just martin_ruiz. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-syntax
Sometimes it makes sense to use ~ and sometimes it's better not to use it. For this PR I would leave it the way it is now, but it's really just down to personal taste.
|
Thanks for the reference @kanderso-nrel! |
Please let us know if we can help :) and thanks again for this PR! |
pvlib.iam.martin_ruizdoes not match code #1561docs/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.Does not apply:
docs/sphinx/source/referencefor API changes.Description of issue in #1561
First time contributor here! Looking forward to make bigger PRs in short, so all tips and criticism is welcomed.