Use array_like in docstring style guide#2816
Conversation
Hey @manav252! 🎉Thanks for opening your first pull request! We appreciate your If AI is used for any portion of this PR, you must vet the content |
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. |
|
@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! |
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor 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`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor 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).remote-data) and Milestone are assigned to the Pull Request and linked Issue.###Description
Updates the contributor style guide to use
array_likeinstead ofarray-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