-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Documentation improvement #335 #336
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
I checked all other occurrences of surface_tilt and think the docstring only needs to be changed in the |
I added the default values in modelchain.py. I looked how default values are added in other libraries such as numpy, pandas, etc. but there doesn't seem to be one common way. I chose the numpy way but can change it if you like. When we agree on how we want the default values to appear in the docstring, I can also add them to the other modules. |
I could also change the orientation_strategy default (#290) if you like. Should this be done in a new PR? |
I don't have any preference on the style. Maybe others can chime in if they care. There are a couple of pvlib functions that already have defaults, and I think they're in the pandas style. #290 should be done in a separate PR. |
I added all default values in pandas style. Just let me know if there is anything you don't agree with. |
Thanks, @birgits, this is great. Can you add a note and your name to the 0.4.6 whatsnew file? |
The failing tests are not related to this PR, so I will go ahead and merge. |
This PR implements the docstring issues addressed in #335.