-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Update irradiance.klucher docs #2192
Conversation
move eqn and add description and variables definition to a new notes section update references redefine surface tilt for consistency with pvlib#2191
update variable names (I_d0 to DHI and add definition of theta as aoi)
add doi
wording in definition of F'
Marked as draft until #2191 has been addressed to avoid duplicate reviews due to similarities between the changes made in these PRs |
\theta->\beta reinstate Loutzenhiser reference
add doi to
add units to returns statement
moved references from first line to notes section
Thanks! Had no idea that issue existed. I have marked #2191 and #2193 as "related to" as well since it was noted in the discussion that:
How should I resolve this comment:
My view: if we keep the (recommended) constraint written in the docs, +1 to changing to "should be" and +0.75 on moving to notes/descriptions. |
Let's address it in a follow-on PR. I agree with your proposed rule (model constraints only in the parameter description, other restrictions in the Notes). But I think text like this is found in many places. The original intent was to inform users of restrictions that would guard against invalid results. That intent wasn't applied consistently, and in places, parameter ranges for model validation were substituted. If we keep ranges in the Notes we need to agree on their purpose. |
@cwhanse okay, I understand that better now. Thanks for explaining. |
Thanks @RDaxini! |
haydavies
#2183, closes Klucher diffuse sky docstring inconsistency #1405docs/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`
).remote-data
) and Milestone are assigned to the Pull Request and linked Issue.Docs here