Skip to content

Use array_like in docstring style guide#2816

Closed
manav252 wants to merge 1 commit into
pvlib:mainfrom
manav252:docs-use-array-like-style
Closed

Use array_like in docstring style guide#2816
manav252 wants to merge 1 commit into
pvlib:mainfrom
manav252:docs-use-array-like-style

Conversation

@manav252

@manav252 manav252 commented Jul 8, 2026

Copy link
Copy Markdown
  • Closes #xxxx
  • 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.
  • [x]Closes use array_like instead of numeric/array-like #765
  • [x]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.Includesnumpydoc compliant docstrings, examples, and comments where necessary.
  • [x]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.

###Description
Updates the contributor style guide to use array_like instead of array-like, matching NumPy terminology.

This changes the descriptor list and the example docstring in the same file.

###Notes
No tests were added because this is a documentation-only change.

No API reference files were changed because this does not modify the public API.

###Checks

  • git diff --check

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

Hey @manav252! 🎉

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.

@manav252

manav252 commented Jul 8, 2026

Copy link
Copy Markdown
Author

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.

Thanks! I’ve reviewed the contributing guidelines and checked the change for accuracy.This PR only updates the style guide wording from 'array-like' to 'array_like' to match the terminology discussed in #765.

@cwhanse

cwhanse commented Jul 8, 2026

Copy link
Copy Markdown
Member

@manav252 we'll live with both 'array-like' and 'array_like' for now, as there are many instances of both terms. The numpy documentation has the same split personality. Thanks for the offer.

@cwhanse cwhanse closed this Jul 8, 2026
@manav252

manav252 commented Jul 8, 2026

Copy link
Copy Markdown
Author

@manav252 we'll live with both 'array-like' and 'array_like' for now, as there are many instances of both terms. The numpy documentation has the same split personality. Thanks for the offer.

Thanks for clarifying!

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.

use array_like instead of numeric/array-like

2 participants