-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Docstring for pvsystem.calcparams_xxx are inconsistent with function code #716
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
Ok with me to change the code to use long names. But I don't think the long/short inconsistency between the docstring/API and internal variable names is necessarily a problem. Our Contributing docs say:
|
Maybe adding a comment line with the return statement will close the bit of gap between the docstring and the variables used in the code. I think it is helpful to use the common symbols as variable names. I don't think including the symbols in the docstring would improve matters; seems like step back from the Contributing goal of full names. |
Can i do like |
The agreement here was to add some comments, e.g. for Changing the output type would require a much longer discussion that we had in this issue. |
Closed by #2405 |
Docstrings for
pvsystem.calcparams_desoto
,pvsystem.calcparams_cec
andpvsystem.calcparams_pvsyst
list outputs asphotocurrent
etc. but code uses different terms, e.g.,IL
. Using the long variable names inside the functions would clarify the code.Might want to consider returning dict rather than tuple.
The text was updated successfully, but these errors were encountered: