docs: remove invalid numpy keyword from ndarray/nans#12125
Merged
Conversation
- Remove inaccurate `numpy.nans` keyword (NumPy has no `nans()` function) - Add `nan` and `NaN` keywords - Populate README See Also section with related packages (`ndarray/empty`, `ndarray/nans-like`) - Add related-links anchors in README links section https://claude.ai/code/session_01HUzihjG6WUrb3PPzR9oQ4w
Replace `nan` and `NaN` with `numpy.full` to follow the established `numpy.<function>` convention used by sibling packages (zeros, ones). NumPy has no `nans()` function; `numpy.full` is the closest analogue. https://claude.ai/code/session_01HUzihjG6WUrb3PPzR9oQ4w
No direct NumPy equivalent exists for a NaN-filling array creation function, so no `numpy.*` keyword is appropriate. https://claude.ai/code/session_01HUzihjG6WUrb3PPzR9oQ4w
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
@stdlib/ndarray/nans@stdlib/ndarray/nans
kgryte
approved these changes
May 14, 2026
@stdlib/ndarray/nansndarray/nans
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request:
"numpy.nans"keyword frompackage.json. NumPy has nonans()function, so this keyword was factually incorrect. No replacement is added since there is no direct NumPy equivalent for a NaN-filling array-creation function.Related Issues
This pull request has the following related issues:
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code.
@stdlib-js/reviewers