Skip to content

DOC: document effect of n_pvrows in pvfactors_timeseries - #2954

Open
WPTK wants to merge 2 commits into
pvlib:mainfrom
WPTK:docs-1398-n-pvrows
Open

WPTK wants to merge 2 commits into
pvlib:mainfrom
WPTK:docs-1398-n-pvrows

Conversation

@WPTK

@WPTK WPTK commented Nov 21, 2026

Copy link
Copy Markdown
  • Closes The effect of n_pvrows on edge effects for pvfactors_timeseries should be documented #1398
  • 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 (not applicable: docstring-only change; pytest tests/bifacial still passes)
  • Updates entries in docs/sphinx/source/reference for API changes (not applicable: no API change)
  • 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.

Documents the effect of n_pvrows on edge effects and runtime in the pvfactors_timeseries docstring, using only what the issue describes (rows are infinite in length but finite in number; a small n_pvrows gives fully illuminated ground at low sun elevation and morning/afternoon rear-irradiance spikes; larger values reduce this but increase runtime significantly). Docstring and whatsnew only, +10/-1.

AI disclosure: this change was drafted with Claude (AI assistance) and I have reviewed the text against the issue.

@github-actions

Copy link
Copy Markdown

Hey @WPTK! 🎉

Thanks for opening your first pull request! We appreciate your
contribution. Please ensure you have reviewed and understood the
contributing guidelines.

If AI is used for any portion of this PR, you must vet the content
for technical accuracy.

Finally, be sure the PR description includes the PR
checklist,
and complete the items you are able to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The effect of n_pvrows on edge effects for pvfactors_timeseries should be documented

1 participant