docs: update descriptions

[Planeshifter]

Propagating fixes merged to develop between 2026-09-28 13:09 UTC and 2026-09-29 13:09 UTC (e0ab571bc^..32c09fd47, 34 commits) to sibling packages.

No associated issue.

Description

What is the purpose of this pull request?

Inline code for NaN in TypeScript declaration descriptions

8ae6d6499, 02bbe4011, and 5c4b61336 rendered NaN as inline code in JSDoc description lines within docs/types/index.d.ts, each covering the packages those commits happened to touch. The 22 lines changed here are the remaining plain occurrences of that phrasing in the file type repo-wide, against 873 already using the inline code form. Target packages:

• stats (namespace declarations, nanminBy and nanrangeBy entries)
• stats/base/ndarray (namespace declarations, dnanrange, dnanrangeabs, and snanmidrange entries)
• stats/base/ndarray/dnanrange
• stats/base/ndarray/dnanrangeabs
• stats/base/ndarray/snanmidrange
• stats/incr/nanmmeanstdev
• stats/nanmin-by
• stats/nanrange-by

The namespace declaration files are regenerated from their member packages' declarations, so each namespace entry is updated together with the member package it derives from and regeneration remains a no-op.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

stats/base/ndarray/sdsnanmeanors was deliberately left out (see below). It is the one package where this phrasing is plain across every artifact rather than only in the declarations, so finishing it is a per-package pass rather than a propagation. Say the word and it can ride along.

Other

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

Validation

• Search scope. ignoring NaN values across all docs/types/index.d.ts under lib/node_modules/@stdlib. 24 hits, all under stats; 22 advanced.
• Two independent validation passes. Both confirmed each line is the summary line of a JSDoc block, contains exactly one occurrence, is not inside an @example, and is not an identifier or type name. Bare NaN inside example code in the same files is untouched.
• Generated-file check. stats/docs/types/index.d.ts and stats/base/ndarray/docs/types/index.d.ts are rewritten by the nightly namespace-declarations job from each member package's trailing JSDoc block. All six namespace lines changed here map to member package lines also changed here, so the job's output is unchanged.
• Style pass. Confirmed the repo renders special values (Infinity, null, undefined, true, false) as inline code in declaration prose, and that the replacement is a pure two-character insertion preserving punctuation at every site.
• Lint. max-len for declarations is { code: 1000, ignorePattern: '^import |// |/?\* ' } and stdlib/jsdoc-maximum-line-length is off, so the added characters carry no line-length risk. No lint rule enforces this convention either way. Repo dev dependencies are not installed in this environment, so the declaration lint was not run locally.

Deliberately excluded

• stats/base/ndarray/sdsnanmeanors (2 lines). The second validation pass rejected it: that package is uniformly plain in its README, repl.txt, lib JSDoc, package.json, and the generated namespace table of contents, so changing only its declarations would make them the lone outlier. Dropped under the "both passes must confirm" rule.
• The corresponding docs/repl.txt lines in stats/nanmin-by, stats/nanrange-by, stats/base/ndarray/dnanrange, and stats/base/ndarray/dnanrangeabs. REPL help wraps at 76 columns, so adding inline code there requires re-wrapping the surrounding paragraph — a reflow beyond the scope of this propagation.
• package.json descriptions, which use the plain form by settled convention (318 plain vs 2 backticked).
• Propagating the consensusOrder change from 100ca4c8d and 32c09fd47 to ndarray/base/kernels/generic/unary-strided1d/unblocked (9 sites). chore: clean-up #15652 corrects the call form at the binary and ternary sites and raises an open question about the intended form; extending it to a third kernel family should wait on that.
• Propagating the [inout] to [out] correction from 8c8948623. Ten textual matches under blas/ext, none valid: dxpy and dxdy compute y[i] = x[i] + y[i] and y[i] = x[i] / y[i], so their second ndarray is genuinely read-modify-write, unlike the write-only output in dwxsa.

Checklist

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

• Read, understood, and followed the contributing guidelines.

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written by Claude Code as an automated pass propagating fixes merged to develop in the stated window to sibling packages. Candidate sites came from a pattern search over the source commits, then two independent validation passes and a style pass reviewed every site; sites the two validation passes disagreed on were dropped. No human has audited these changes yet, so the PR is opened as a draft.

---

@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_01VYzCUqHiEst6mVYhP72gSS

---

Generated by Claude Code

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
stats	$\\color{red}226264/270637$ $\\color{green}+83.60\\%$	$\\color{red}3746/3992$ $\\color{green}+93.84\\%$	$\\color{red}3/2533$ $\\color{green}+0.12\\%$	$\\color{red}226264/270637$ $\\color{green}+83.60\\%$
stats/base/ndarray	$\\color{red}26740/28441$ $\\color{green}+94.02\\%$	$\\color{red}451/515$ $\\color{green}+87.57\\%$	$\\color{red}0/257$ $\\color{green}+0.00\\%$	$\\color{red}26740/28441$ $\\color{green}+94.02\\%$
stats/base/ndarray/dnanrange	$\\color{green}176/176$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}176/176$ $\\color{green}+100.00\\%$
stats/base/ndarray/dnanrangeabs	$\\color{green}176/176$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}176/176$ $\\color{green}+100.00\\%$
stats/base/ndarray/snanmidrange	$\\color{green}103/103$ $\\color{green}+100.00\\%$	$\\color{green}3/3$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}103/103$ $\\color{green}+100.00\\%$
stats/incr/nanmmeanstdev	$\\color{green}144/144$ $\\color{green}+100.00\\%$	$\\color{green}10/10$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}144/144$ $\\color{green}+100.00\\%$
stats/nanmin-by	$\\color{green}161/161$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}0/0$ $\\color{green}+100.00\\%$	$\\color{green}161/161$ $\\color{green}+100.00\\%$
stats/nanrange-by	$\\color{green}161/161$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}0/0$ $\\color{green}+100.00\\%$	$\\color{green}161/161$ $\\color{green}+100.00\\%$

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