Skip to content

Commit

Permalink
none's, some more ``'s to variables and some other nones
Browse files Browse the repository at this point in the history
Co-Authored-By: Cliff Hansen <5393711+cwhanse@users.noreply.github.com>
  • Loading branch information
echedey-ls and cwhanse committed Oct 31, 2023
1 parent 9c52070 commit 232156c
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions pvlib/iam.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ def physical(aoi, n=1.526, K=4.0, L=0.002, *, n_ar=None):
n_ar : numeric, optional
The effective index of refraction of the anti-reflective (AR) coating
(unitless). If n_ar is None (default), no AR coating is applied.
(unitless). If n_ar is not supplied, no AR coating is applied.
A typical value for the effective index of an AR coating is 1.29.
Returns
Expand Down Expand Up @@ -338,7 +338,7 @@ def martin_ruiz_diffuse(surface_tilt, a_r=0.16, c1=0.4244, c2=None):
c2 : float
Second fitting parameter for the expressions that approximate the
integral of diffuse irradiance coming from different directions.
If c2 is None, it will be calculated according to the linear
If c2 is not specified, it will be calculated according to the linear
relationship given in [3]_.
Returns
Expand Down
14 changes: 7 additions & 7 deletions pvlib/iotools/pvgis.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
userhorizon: list of float, default: None
Optional user specified elevation of horizon in degrees, at equally
spaced azimuth clockwise from north, only valid if ``usehorizon`` is
true, if ``usehorizon`` is true but ``userhorizon`` is ``None`` then
true, if ``usehorizon`` is true but ``userhorizon`` is not specified then
PVGIS will calculate the horizon [4]_
pvcalculation: bool, default: False
Return estimate of hourly PV production.
Expand Down Expand Up @@ -312,7 +312,7 @@ def read_pvgis_hourly(filename, pvgis_format=None, map_variables=True):
pvgis_format : str, optional
Format of PVGIS file or buffer. Equivalent to the ``outputformat``
parameter in the PVGIS API. If ``filename`` is a file and
``pvgis_format`` is ``None`` then the file extension will be used to
``pvgis_format`` is not specified then the file extension will be used to

Check failure on line 315 in pvlib/iotools/pvgis.py

View workflow job for this annotation

GitHub Actions / flake8-linter

E501 line too long (81 > 79 characters)
determine the PVGIS format to parse. If ``filename`` is a buffer, then
``pvgis_format`` is required and must be in ``['csv', 'json']``.
map_variables: bool, default True
Expand All @@ -336,11 +336,11 @@ def read_pvgis_hourly(filename, pvgis_format=None, map_variables=True):
Raises
------
ValueError
if ``pvgis_format`` is ``None`` and the file extension is neither
if ``pvgis_format`` is not specified and the file extension is neither
``.csv`` nor ``.json`` or if ``pvgis_format`` is provided as
input but isn't in ``['csv', 'json']``
TypeError
if ``pvgis_format`` is ``None`` and ``filename`` is a buffer
if ``pvgis_format`` is not specified and ``filename`` is a buffer
See Also
--------
Expand Down Expand Up @@ -575,7 +575,7 @@ def read_pvgis_tmy(filename, pvgis_format=None, map_variables=True):
pvgis_format : str, optional
Format of PVGIS file or buffer. Equivalent to the ``outputformat``
parameter in the PVGIS TMY API. If ``filename`` is a file and
``pvgis_format`` is ``None`` then the file extension will be used to
``pvgis_format`` is not specified then the file extension will be used to

Check failure on line 578 in pvlib/iotools/pvgis.py

View workflow job for this annotation

GitHub Actions / flake8-linter

E501 line too long (81 > 79 characters)
determine the PVGIS format to parse. For PVGIS files from the API with
``outputformat='basic'``, please set ``pvgis_format`` to ``'basic'``.
If ``filename`` is a buffer, then ``pvgis_format`` is required and must
Expand All @@ -599,11 +599,11 @@ def read_pvgis_tmy(filename, pvgis_format=None, map_variables=True):
Raises
------
ValueError
if ``pvgis_format`` is ``None`` and the file extension is neither
if ``pvgis_format`` is not specified and the file extension is neither
``.csv``, ``.json``, nor ``.epw``, or if ``pvgis_format`` is provided
as input but isn't in ``['csv', 'epw', 'json', 'basic']``
TypeError
if ``pvgis_format`` is ``None`` and ``filename`` is a buffer
if ``pvgis_format`` is not specified and ``filename`` is a buffer
See Also
--------
Expand Down
2 changes: 1 addition & 1 deletion pvlib/irradiance.py
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ def get_sky_diffuse(surface_tilt, surface_azimuth,
------
ValueError
If model is one of ``'haydavies'``, ``'reindl'``, or ``'perez'`` and
``dni_extra`` is ``None``.
``dni_extra`` is not specified.
Notes
-----
Expand Down
8 changes: 4 additions & 4 deletions pvlib/pvsystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ class PVSystem:
North=0, East=90, South=180, West=270.
albedo : float, optional
Ground surface albedo. If ``None``, then ``surface_type`` is used
Ground surface albedo. If not supplied, then ``surface_type`` is used
to look up a value in ``irradiance.SURFACE_ALBEDOS``.
If ``surface_type`` is also None then a ground surface albedo
If ``surface_type`` is also not supplied then a ground surface albedo
of 0.25 is used.
surface_type : string, optional
Expand Down Expand Up @@ -907,9 +907,9 @@ class Array:
If not provided, a FixedMount with zero tilt is used.
albedo : float, optional
Ground surface albedo. If ``None``, then ``surface_type`` is used
Ground surface albedo. If not supplied, then ``surface_type`` is used
to look up a value in ``irradiance.SURFACE_ALBEDOS``.
If ``surface_type`` is also None then a ground surface albedo
If ``surface_type`` is also not supplied then a ground surface albedo
of 0.25 is used.
surface_type : string, optional
Expand Down
8 changes: 4 additions & 4 deletions pvlib/solarposition.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ def get_solarposition(time, latitude, longitude,
negative to west.
altitude : float, optional
If not specified, computed from pressure. Assumed to be 0 m
if pressure is also None.
If not specified, computed from ``pressure``. Assumed to be 0 m
if ``pressure`` is not supplied.
pressure : float, optional
If not specified, computed from altitude. Assumed to be 101325 Pa
if altitude is also None.
If not specified, computed from ``altitude``. Assumed to be 101325 Pa
if ``altitude`` is not supplied.
method : string, default 'nrel_numpy'
'nrel_numpy' uses an implementation of the NREL SPA algorithm
Expand Down

0 comments on commit 232156c

Please sign in to comment.