docs: fix stale plural-function wording in stats/array/stdev#12325
Open
Planeshifter wants to merge 1 commit into
Open
docs: fix stale plural-function wording in stats/array/stdev#12325Planeshifter wants to merge 1 commit into
stats/array/stdev#12325Planeshifter wants to merge 1 commit into
Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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:
stats/array/stdev's Notes section. The package exports a single function, but one bullet read "...both functions returnNaN" — leftover wording copied from the strided counterpart (stats/strided/stdev), where both a positional form and an.ndarraymethod are exported. Replaced with the singular "...the function returnsNaN", matching all 11 sibling stdev/nanstdev variants (stdevch,stdevpn,stdevtk,stdevwd,stdevyc,nanstdev,nanstdevch,nanstdevpn,nanstdevtk,nanstdevwd,nanstdevyc— 100% sibling conformance).stats/array/stdevstats/array/stdev/README.mdwas the lone outlier in thestats/arraynamespace carrying the plural "both functions returnNaN" phrasing in its Notes section. The package exports a single function (no.ndarraymethod attached); the wording is residual from the strided counterpart and is contradicted by the surrounding bullets, which already use the singular ("...the function returnsNaN" 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
No.
Questions
No.
Other
Sibling conformance: 11/11 stdev/nanstdev variants use the singular phrasing; this is the only namespace member that diverged.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
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 asconfirmed-drifton 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