Skip to content

docs: fix stale plural-function wording in stats/array/stdev#12325

Open
Planeshifter wants to merge 1 commit into
developfrom
philipp/drift-stats-array-2026-05-28
Open

docs: fix stale plural-function wording in stats/array/stdev#12325
Planeshifter wants to merge 1 commit into
developfrom
philipp/drift-stats-array-2026-05-28

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • docs: correct a residual two-function phrasing in stats/array/stdev's Notes section. The package exports a single function, but one bullet read "...both functions return NaN" — leftover wording copied from the strided counterpart (stats/strided/stdev), where both a positional form and an .ndarray method are exported. Replaced with the singular "...the function returns NaN", matching all 11 sibling stdev/nanstdev variants (stdevch, stdevpn, stdevtk, stdevwd, stdevyc, nanstdev, nanstdevch, nanstdevpn, nanstdevtk, nanstdevwd, nanstdevyc — 100% sibling conformance).

stats/array/stdev

stats/array/stdev/README.md was the lone outlier in the stats/array namespace carrying the plural "both functions return NaN" phrasing in its Notes section. The package exports a single function (no .ndarray method attached); the wording is residual from the strided counterpart and is contradicted by the surrounding bullets, which already use the singular ("...the function returns NaN" on the preceding line; "...the function supports array-like objects..." on the following line). Aligns the line with the 11 stdev/nanstdev siblings in the same namespace. README-only change; no observable behavior, signature, or test expectation changes.

Related Issues

Does this pull request have any related issues?

No.

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.

Sibling conformance: 11/11 stdev/nanstdev variants use the singular phrasing; this is the only namespace member that diverged.

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 authored by Claude Code running a cross-package drift-detection routine against @stdlib/stats/array: structural and semantic features were extracted from all 69 namespace members, the majority pattern per feature was computed (with a 75% threshold), and outliers were flagged. A three-agent validation pass (semantic-review, cross-reference, structural-review) confirmed this specific change as confirmed-drift on all three axes before it was applied. The change is a one-line README wording fix; the supporting analysis is in a local report and was not committed to the tree.



Generated by Claude Code

The package exports a single function, but a Notes-section bullet read
"both functions return `NaN`" — residual phrasing copied from the
strided counterpart (`stats/strided/stdev`), which exports both a
positional and an `.ndarray` form. All sibling array-stdev packages
(stdevch, stdevpn, stdevtk, stdevwd, stdevyc) and their nan*
counterparts use the singular "the function returns `NaN`"
(11/11 = 100% sibling conformance). Aligns this README with the
sibling pattern.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label May 28, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/array/stdev $\color{green}123/123$
$\color{green}+100.00%$
$\color{green}12/12$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}123/123$
$\color{green}+100.00%$

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

@Planeshifter Planeshifter marked this pull request as ready for review May 28, 2026 04:22
@Planeshifter Planeshifter requested review from a team and kgryte May 28, 2026 04:22
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Review A pull request which needs code review. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants