Skip to content

docs: remove invalid numpy keyword from ndarray/nans#12125

Merged
kgryte merged 6 commits into
developfrom
claude/vibrant-brahmagupta-xXAJI
May 14, 2026
Merged

docs: remove invalid numpy keyword from ndarray/nans#12125
kgryte merged 6 commits into
developfrom
claude/vibrant-brahmagupta-xXAJI

Conversation

@Planeshifter

@Planeshifter Planeshifter commented May 14, 2026

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • Removes the "numpy.nans" keyword from package.json. NumPy has no nans() 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

Does this pull request have any related issues?

This pull request has the following related issues:

  • stdlib-js/todo#2774

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

This PR was written primarily by Claude Code.


@stdlib-js/reviewers

claude added 6 commits May 14, 2026 04:11
- 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
@stdlib-bot

stdlib-bot commented May 14, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/nans $\color{green}207/207$
$\color{green}+100.00%$
$\color{green}32/32$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}207/207$
$\color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

@Planeshifter Planeshifter changed the title docs: review @stdlib/ndarray/nans docs: remove invalid numpy keyword from @stdlib/ndarray/nans May 14, 2026
@Planeshifter Planeshifter marked this pull request as ready for review May 14, 2026 05:02
@Planeshifter Planeshifter requested review from a team and kgryte May 14, 2026 05:02
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 14, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label May 14, 2026
@kgryte kgryte changed the title docs: remove invalid numpy keyword from @stdlib/ndarray/nans docs: remove invalid numpy keyword from ndarray/nans May 14, 2026
@kgryte kgryte merged commit 65cbb12 into develop May 14, 2026
41 checks passed
@kgryte kgryte deleted the claude/vibrant-brahmagupta-xXAJI branch May 14, 2026 05:54
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.

4 participants