Skip to content

Commit e465313

Browse files
r0hansaxenacwhanseechedey-lsRDaxini
authored
Fix PVSystem module_type docstring default (pvlib#2713)
* Fix PVSystem module_type docstring default * Fix docstring references in v0.15.1 release notes Updated issue and pull request references for clarity. * Update docs/sphinx/source/whatsnew/v0.15.1.rst Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update pvlib/pvsystem.py Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> * Apply suggestion from @RDaxini Co-authored-by: Rajiv Daxini <143435106+RDaxini@users.noreply.github.com> --------- Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> Co-authored-by: Rajiv Daxini <143435106+RDaxini@users.noreply.github.com>
1 parent fec2a77 commit e465313

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/sphinx/source/whatsnew/v0.15.1.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ Documentation
4040
* Add AI checkbox to PR template, and auto-generate a comment on PRs
4141
from first-time contributors regarding AI and contributing guidelines.
4242
(:issue:`2617`, :pull:`2624`)
43+
* Update :py:class:`pvlib.pvsystem.PVSystem` docstring to state that
44+
``module_type`` is optional.
45+
(:issue:`2634`, :pull:`2713`)
4346
* Fix a broken docstring reference to ``grounddiffuse`` in
4447
:py:func:`pvlib.irradiance.poa_components`
4548
(:issue:`2089`, :pull:`2708`)

pvlib/pvsystem.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ class PVSystem:
140140
module : string, optional
141141
The model name of the modules.
142142
143-
module_type : string, default 'glass_polymer'
143+
module_type : string, optional
144144
Describes the module's construction. Valid strings are 'glass_polymer'
145145
and 'glass_glass'. Used for cell and module temperature calculations.
146146

0 commit comments

Comments
 (0)