Skip to content

Commit 1c2dd73

Browse files
committed
docstring: update per code review (II)
1 parent 31b0ac8 commit 1c2dd73

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

pvlib/spectrum/mismatch.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -286,10 +286,11 @@ def martin_ruiz_spectral_modifier(clearness_index, airmass_absolute,
286286
index=('c', 'a', 'b'))
287287
288288
``c``, ``a`` and ``b`` must be scalar.
289-
```suggestion
290-
If parameters for an irradiance component (`'poa_direct'`,
291-
`'poa_sky_diffuse'`, or `'poa_ground_diffuse'`) are not
292-
specified, ``np.nan`` will be returned in the corresponding value.
289+
290+
Unspecified parameters for an irradiance component (`'poa_direct'`,
291+
`'poa_sky_diffuse'`, or `'poa_ground_diffuse'`) will cause ``np.nan``
292+
to be returned in the corresponding result.
293+
293294
Returns
294295
-------
295296
Modifiers : pd.DataFrame (iterable input) or dict (scalar input) of numeric
@@ -298,8 +299,6 @@ def martin_ruiz_spectral_modifier(clearness_index, airmass_absolute,
298299
`'poa_ground_diffuse'`.
299300
Each mismatch modifier should be multiplied by its corresponding
300301
POA component.
301-
Returns np.nan for a component if provided ``model_parameters`` does
302-
not include its coefficients.
303302
304303
Raises
305304
------

0 commit comments

Comments
 (0)