-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Consistent names for reference kwargs #825
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
Comments
Consistency would be great. I'm not a fan of really long names, but you already knew that. |
I just came across |
@wholmgren what is your view of the benefit of this proposed change? |
@cwhanse I'm +1 on changing them. I like your suggestions, but here are some quick searches for consistency... I see pvterms has a different set of suggestions, To @adriesse's point, I'm a fan of really long names, but you already knew that. |
@cwhanse there's also the
|
It seems like we already have the tools to fix this issue (the variable naming table, and the deprecated kwarg decorator) and it would be a great benefit. I think this issue deserves a vote on where the
|
Either 👍 or 🚀 are OK with me. I prefer placing the adjective 'reference' after the noun 'irradiance' |
Let's allow for exceptions to the rule, if something sounds awkward. |
…ystem.sapm` (#2434) * add ref irr/t as optional args, rename * add terms to docs * linter * Update v0.12.1.rst * move whatsnew entry from docs to enhancements * multiple instances of C -> °C * name change (#825) * Update v0.12.1.rst * missing ` * remove unused package * change to kwarg only parameters Co-Authored-By: Echedey Luis <[email protected]> * Revert "Update v0.12.1.rst" This reverts commit e8a7b10. * update names, remove duplicate entry * remove ivtools line. mistakenly added during merge branch? * Update docs/sphinx/source/whatsnew/v0.12.1.rst Co-authored-by: Echedey Luis <[email protected]> --------- Co-authored-by: Echedey Luis <[email protected]>
Is your feature request related to a problem? Please describe.
Both
irrad_ref
andreference_irradiance
are used for the reference irradiance kwarg for effective irradiance and DC models.Describe the solution you'd like
Suggest it is worth changing to
reference_irradiance
throughout, and to replacetemp_ref
byreference_temperature
.The text was updated successfully, but these errors were encountered: