8000 Docstring cleanup: "default None", doi by echedey-ls · Pull Request #1828 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]

Skip to content

Docstring cleanup: "default None", doi #1828

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

Merged
merged 29 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
29b3aa8
Align reference
echedey-ls Jun 26, 2023
15d8107
Update irradiance.py
echedey-ls Jun 26, 2023
9c5f6b2
Remove parenthesis in types
echedey-ls Aug 6, 2023
059f32c
Remove none in type definition #1574
echedey-ls Aug 6, 2023
96a4f58
Change if none ocurrences (I)
echedey-ls Aug 6, 2023
a89addb
Change if none ocurrences (II)
echedey-ls Aug 6, 2023
e931a5d
Too long line
echedey-ls Aug 6, 2023
e9495e0
Too long line
echedey-ls Aug 6, 2023
469edc2
fix doi external links
echedey-ls Oct 28, 2023
7b3cc76
Merge branch 'main' into refactor-docstring-params- 8000 2
echedey-ls Oct 28, 2023
1bc3b12
Apply cwhanse suggestion
echedey-ls Oct 31, 2023
57f67bb
Apply cwhanse suggestion
echedey-ls Oct 31, 2023
8794a2e
Apply cwhanse suggestion
echedey-ls Oct 31, 2023
2378db1
Apply cwhanse suggestion
echedey-ls Oct 31, 2023
6171e77
Modified cwhanse suggestion
echedey-ls Oct 31, 2023
3c3779e
Merge branch 'refactor-docstring-params-2' of https://github.com/eche…
echedey-ls Oct 31, 2023
c75a662
Update modelchain.py
echedey-ls Oct 31, 2023
9c52070
Some None's missed
echedey-ls Oct 31, 2023
232156c
``none``'s, some more ``'s to variables and some other nones
echedey-ls Oct 31, 2023
b8f942b
Special ``none`` cases (please review)
echedey-ls Oct 31, 2023
f7c6c7c
Linter
echedey-ls Oct 31, 2023
ec2b176
Run more regexes
echedey-ls Oct 31, 2023
daa5e65
More Nones
echedey-ls Nov 1, 2023
8ddcd7e
Update irradiance.py
echedey-ls Nov 1, 2023
1a39119
Revert "Special ``none`` cases (please review)"
echedey-ls Nov 2, 2023
eb0806d
Apply suggestions from code review
echedey-ls Nov 2, 2023
57d61af
Update irradiance.py
echedey-ls Nov 2, 2023
69c8321
Update pvlib/irradiance.py
echedey-ls Nov 2, 2023
1f24c92
Update irradiance.py
echedey-ls Nov 3, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix doi external links
Regex find: (?:doi|DOI):(?!`)\s?(.*?)(\.\n|\n)
Replace: :doi:`$1`$2
  • Loading branch information
echedey-ls committed Oct 28, 2023
commit 469edc23cf6e8e08897505819324a917d3fc4925
2 changes: 1 addition & 1 deletion pvlib/bifacial/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ def _unshaded_ground_fraction(surface_tilt, surface_azimuth, solar_zenith,
.. [1] Mikofski, M., Darawali, R., Hamer, M., Neubert, A., and Newmiller,
J. "Bifacial Performance Modeling in Large Arrays". 2019 IEEE 46th
Photovoltaic Specialists Conference (PVSC), 2019, pp. 1282-1287.
doi: 10.1109/PVSC40753.2019.8980572.
:doi:`10.1109/PVSC40753.2019.8980572`.
"""
tan_phi = _solar_projection_tangent(solar_zenith, solar_azimuth,
surface_azimuth)
Expand Down
6 changes: 3 additions & 3 deletions pvlib/iam.py
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ def sapm(aoi, module, upper=None):

.. [3] B.H. King et al, "Recent Advancements in Outdoor Measurement
Techniques for Angle of Incidence Effects," 42nd IEEE PVSC (2015).
DOI: 10.1109/PVSC.2015.7355849
:doi:`10.1109/PVSC.2015.7355849`

See Also
--------
Expand Down Expand Up @@ -607,7 +607,7 @@ def marion_diffuse(model, surface_tilt, **kwargs):
.. [1] B. Marion "Numerical method for angle-of-incidence correction
factors for diffuse radiation incident photovoltaic modules",
Solar Energy, Volume 147, Pages 344-348. 2017.
DOI: 10.1016/j.solener.2017.03.027
:doi:`10.1016/j.solener.2017.03.027`

Examples
--------
Expand Down Expand Up @@ -694,7 +694,7 @@ def marion_integrate(function, surface_tilt, region, num=None):
.. [1] B. Marion "Numerical method for angle-of-incidence correction
factors for diffuse radiation incident photovoltaic modules",
Solar Energy, Volume 147, Pages 344-348. 2017.
DOI: 10.1016/j.solener.2017.03.027
:doi:`10.1016/j.solener.2017.03.027`

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion pvlib/ivtools/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def _numdiff(x, f):
----------
.. [1] M. K. Bowen, R. Smith, "Derivative formulae and errors for
non-uniformly spaced points", Proceedings of the Royal Society A, vol.
461 pp 1975 - 1997, July 2005. DOI: 10.1098/rpsa.2004.1430
461 pp 1975 - 1997, July 2005. :doi:`10.1098/rpsa.2004.1430`
.. [2] PVLib MATLAB https://github.com/sandialabs/MATLAB_PV_LIB
"""

Expand Down
6 changes: 3 additions & 3 deletions pvlib/shading.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def masking_angle(surface_tilt, gcr, slant_height):
----------
.. [1] D. Passias and B. Källbäck, "Shading effects in rows of solar cell
panels", Solar Cells, Volume 11, Pages 281-291. 1984.
DOI: 10.1016/0379-6787(84)90017-6
:doi:`10.1016/0379-6787(84)90017-6`
.. [2] Gilman, P. et al., (2018). "SAM Photovoltaic Model Technical
Reference Update", NREL Technical Report NREL/TP-6A20-67399.
Available at https://www.nrel.gov/docs/fy18osti/67399.pdf
Expand Down Expand Up @@ -167,7 +167,7 @@ def masking_angle_passias(surface_tilt, gcr):
----------
.. [1] D. Passias and B. Källbäck, "Shading effects in rows of solar cell
panels", Solar Cells, Volume 11, Pages 281-291. 1984.
DOI: 10.1016/0379-6787(84)90017-6
:doi:`10.1016/0379-6787(84)90017-6`
"""
# wrap it in an array so that division by zero is handled well
beta = np.radians(np.array(surface_tilt))
Expand Down Expand Up @@ -226,7 +226,7 @@ def sky_diffuse_passias(masking_angle):
----------
.. [1] D. Passias and B. Källbäck, "Shading effects in rows of solar cell
panels", Solar Cells, Volume 11, Pages 281-291. 1984.
DOI: 10.1016/0379-6787(84)90017-6
:doi:`10.1016/0379-6787(84)90017-6`
.. [2] Gilman, P. et al., (2018). "SAM Photovoltaic Model Technical
Reference Update", NREL Technical Report NREL/TP-6A20-67399.
Available at https://www.nrel.gov/docs/fy18osti/67399.pdf
Expand Down
2 changes: 1 addition & 1 deletion pvlib/soiling.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def hsu(rainfall, cleaning_threshold, surface_tilt, pm2_5, pm10,
-----------
.. [1] M. Coello and L. Boyle, "Simple Model For Predicting Time Series
Soiling of Photovoltaic Panels," in IEEE Journal of Photovoltaics.
doi: 10.1109/JPHOTOV.2019.2919628
:doi:`10.1109/JPHOTOV.2019.2919628`
.. [2] Atmospheric Chemistry and Physics: From Air Pollution to Climate
Change. J. Seinfeld and S. Pandis. Wiley and Sons 2001.

Expand Down
2 changes: 1 addition & 1 deletion pvlib/spectrum/spectrl2.py
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ def spectrl2(apparent_zenith, aoi, surface_tilt, ground_albedo,
.. [1] Bird, R, and Riordan, C., 1984, "Simple solar spectral model for
direct and diffuse irradiance on horizontal and tilted planes at the
earth's surface for cloudless atmospheres", NREL Technical Report
TR-215-2436 doi:10.2172/5986936.
TR-215-2436 :doi:`10.2172/5986936`.
.. [2] Bird Simple Spectral Model: spectrl2_2.c.
https://www.nrel.gov/grid/solar-resource/spectral.html
"""
Expand Down
2 changes: 1 addition & 1 deletion pvlib/temperature.py
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ def fuentes(poa_global, temp_air, wind_speed, noct_installed, module_height=5,
http://prod.sandia.gov/techlib/access-control.cgi/1985/850330.pdf
.. [2] Dobos, A. P., 2014, "PVWatts Version 5 Manual", NREL/TP-6A20-62641,
National Renewable Energy Laboratory, Golden CO.
doi:10.2172/1158421.
:doi:`10.2172/1158421`.
"""
# ported from the FORTRAN77 code provided in Appendix A of Fuentes 1987;
# nearly all variable names are kept the same for ease of comparison.
Expand Down
0