Skip to content

Commit a5e84de

Browse files
committed
docstring edits
1 parent 36744dc commit a5e84de

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pvlib/clearsky.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,7 @@ def detect_clearsky(measured, clearsky, times=None, infer_limits=False,
695695
Statistics are calculated using a sliding time window (e.g., 10
696696
minutes). An iterative algorithm identifies clear periods, uses the
697697
identified periods to estimate bias in the clearsky data, scales the
698-
clearsky data and repeats
698+
clearsky data and repeats.
699699
700700
Clear times are identified by meeting five criteria. Default values for
701701
these thresholds are appropriate for 10 minute windows of 1 minute
@@ -750,17 +750,17 @@ def detect_clearsky(measured, clearsky, times=None, infer_limits=False,
750750
751751
components : OrderedDict, optional
752752
Dict of arrays of whether or not the given time window is clear
753-
for each condition. Only provided if return_components is True.
753+
for each condition. Only provided if ``return_components`` is True.
754754
755755
alpha : scalar, optional
756-
Scaling factor applied to the ``clearsky_ghi`` to obtain the
757-
detected clear_samples. Only provided if return_components is
756+
Scaling factor applied to ``clearsky`` to obtain the
757+
detected ``clear_samples``. Only provided if ``return_components`` is
758758
True.
759759
760760
Raises
761761
------
762762
ValueError
763-
If measured is not a Series and times is not provided.
763+
If ``measured`` is not a Series and times is not provided.
764764
ValueError
765765
If a window contains less than three data points.
766766
ValueError

0 commit comments

Comments
 (0)