Skip to content

Fix PVSystem module_type docstring default#2713

Open
r0hansaxena wants to merge 4 commits intopvlib:mainfrom
r0hansaxena:fix-2634
Open

Fix PVSystem module_type docstring default#2713
r0hansaxena wants to merge 4 commits intopvlib:mainfrom
r0hansaxena:fix-2634

Conversation

@r0hansaxena
Copy link
Contributor

  • Closes pvlib.pvsystem.PVSystem states wrong default for module_type #2634
  • I am familiar with the contributing guidelines
  • I attest that all AI-generated material has been vetted for accuracy and is in compliance with the pvlib license
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

The module_type parameter in PVSystem is documented as having a default value of 'glass_polymer', but the actual default is None. This PR corrects the docstring to reflect the actual default.

@echedey-ls
Copy link
Member

Please, see #1574

Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
@r0hansaxena r0hansaxena requested a review from cwhanse March 9, 2026 14:34
Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com>
Copy link
Member

@RDaxini RDaxini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the whatsnew entry now needs to be updated

Comment on lines +41 to +43
* Correct :py:class:`pvlib.pvsystem.PVSystem` docstring to state that
``module_type`` defaults to ``None``.
(:issue:`2634`, :pull:`2713`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Correct :py:class:`pvlib.pvsystem.PVSystem` docstring to state that
``module_type`` defaults to ``None``.
(:issue:`2634`, :pull:`2713`)
* Update :py:class:`pvlib.pvsystem.PVSystem` docstring to state that
``module_type`` is optional.
(:issue:`2634`, :pull:`2713`)

@RDaxini
Copy link
Member

RDaxini commented Mar 10, 2026

@r0hansaxena thanks for your contribution. I did want to say though that I couldn't help but notice that the review/commit history here seems to suggest you did not review the comment from @echedey-ls #2713 (comment), which led to him having to make the change for you to commit. In future, it would be helpful to review all feedback thoroughly and act accordingly, to save everyone time and ensure we still get these important fixes pushed through efficiently. If you ever have questions about reviews or comments, you can always post a follow up comment to ask and clarify.

@RDaxini RDaxini added this to the v0.15.1 milestone Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

pvlib.pvsystem.PVSystem states wrong default for module_type

4 participants