Skip to content

Commit 2eb1d4d

Browse files
echedey-lscwhanse
andauthored
docstring: Apply suggestions from code review
Co-authored-by: Cliff Hansen <[email protected]>
1 parent 4599a48 commit 2eb1d4d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

pvlib/spectrum/mismatch.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -259,17 +259,14 @@ def martin_ruiz_spectral_modifier(clearness_index, airmass_absolute,
259259
airmass_absolute : numeric
260260
Absolute airmass. Give attention to algorithm used (``kasten1966`` is
261261
recommended for default parameters of ``monosi``, ``polysi`` and
262-
``asi``, see reference [1]_).
262+
``asi``, see [1]_).
263263
264264
cell_type : string, optional
265265
Specifies material of the cell in order to infer model parameters.
266266
Allowed types are ``monosi``, ``polysi`` and ``asi``, either lower or
267267
upper case. If not specified, ``model_parameters`` must be provided.
268268
269269
model_parameters : dict-like, optional
270-
In case you computed the model parameters. In case any component is not
271-
specified, result will have a ``np.nan`` value in its
272-
corresponding value.
273270
Provide either a dict or a ``pd.DataFrame`` as follows:
274271
275272
.. code-block:: python
@@ -289,13 +286,16 @@ def martin_ruiz_spectral_modifier(clearness_index, airmass_absolute,
289286
index=('c', 'a', 'b'))
290287
291288
``c``, ``a`` and ``b`` must be scalar.
292-
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.
293293
Returns
294294
-------
295295
Modifiers : pd.DataFrame (iterable input) or dict (scalar input) of numeric
296296
Mismatch modifiers for direct, sky diffuse and ground diffuse
297-
irradiances, with indexes ``poa_direct``, ``poa_sky_diffuse``,
298-
``poa_ground_diffuse``.
297+
irradiances, with indexes `'poa_direct'`, `'poa_sky_diffuse'`,
298+
`'poa_ground_diffuse'`.
299299
Each mismatch modifier should be multiplied by its corresponding
300300
POA component.
301301
Returns np.nan for a component if provided ``model_parameters`` does

0 commit comments

Comments
 (0)