Skip to content

Commit 3c3779e

Browse files
committed
Merge branch 'refactor-docstring-params-2' of https://github.com/echedey-ls/pvlib-python into refactor-docstring-params-2
2 parents 6171e77 + 2378db1 commit 3c3779e

File tree

4 files changed

+6
-7
lines changed

4 files changed

+6
-7
lines changed

pvlib/clearsky.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -705,7 +705,7 @@ def detect_clearsky(measured, clearsky, times=None, infer_limits=False,
705705
Time series of the expected clearsky GHI. [W/m2]
706706
times : DatetimeIndex or None, default None.
707707
Times of measured and clearsky values. If not specified, the index of
708-
measured will be used.
708+
``measured`` will be used.
709709
infer_limits : bool, default False
710710
If True, does not use passed in kwargs (or defaults), but instead
711711
interpolates these values from Table 1 in [2]_.

pvlib/iotools/pvgis.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -410,10 +410,9 @@ def get_pvgis_tmy(latitude, longitude, outputformat='json', usehorizon=True,
410410
usehorizon : bool, default True
411411
include effects of horizon
412412
userhorizon : list of float, optional
413-
optional user specified elevation of horizon in degrees, at equally
414-
spaced azimuth clockwise from north, only valid if ``usehorizon`` is
415-
true, if ``usehorizon`` is true but ``userhorizon`` is ``None`` then
416-
PVGIS will calculate the horizon [3]_
413+
Optional user-specified elevation of horizon in degrees, at equally
414+
spaced azimuth clockwise from north. If not specified, PVGIS will
415+
calculate the horizon [3]_. If specified, requires ``usehorizon=True``.
417416
startyear : int, optional
418417
first year to calculate TMY
419418
endyear : int, optional

pvlib/iotools/tmy.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
4141
filename : str
4242
A relative file path or absolute file path.
4343
coerce_year : int, optional
44-
If supplied, the year of the index will be set to `coerce_year`, except
44+
If supplied, the year of the index will be set to ``coerce_year``, except
4545
for the last index value which will be set to the *next* year so that
4646
the index increases monotonically.
4747
map_variables : bool, optional

pvlib/irradiance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -575,7 +575,7 @@ def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
575575
overridden if surface_type is supplied.
576576
577577
surface_type : string, optional
578-
If not None, overrides albedo. String can be one of 'urban',
578+
If supplied, overrides ``albedo``. String can be one of 'urban',
579579
'grass', 'fresh grass', 'snow', 'fresh snow', 'asphalt', 'concrete',
580580
'aluminum', 'copper', 'fresh steel', 'dirty steel', 'sea'.
581581

0 commit comments

Comments
 (0)