docs: updae descriptions in stats/strided/*abs package descriptions#12310
Merged
Conversation
The `package.json` "description" field and `README.md` intro blockquote previously began with the imperative verb "Compute". Across the 239 non-aggregator packages in `@stdlib/stats/strided`, 227 (95.0%) use "Calculate" in these fields; only 5 packages — all `*abs` variants — used "Compute". The non-abs sibling `drange` and the generic abs sibling `rangeabs` both already say "Calculate"; the JSDoc, `docs/repl.txt`, and `docs/types/index.d.ts` continue to use the gerund "Computes", consistent with sibling convention and unchanged by this commit.
The `package.json` "description" field and `README.md` intro blockquote previously began with the imperative verb "Compute". Across the 239 non-aggregator packages in `@stdlib/stats/strided`, 227 (95.0%) use "Calculate" in these fields. The non-abs sibling `dnanrange` and the generic NaN-skipping abs sibling `nanrangeabs` both say "Calculate"; the JSDoc, `docs/repl.txt`, and `docs/types/index.d.ts` continue to use the gerund "Computes" (consistent across all 239 packages) and are unchanged.
The `package.json` "description" field and `README.md` intro blockquote previously began with the imperative verb "Compute". Across the 239 non-aggregator packages in `@stdlib/stats/strided`, 227 (95.0%) use "Calculate" in these fields. The non-abs sibling `srange` and the float64 counterpart `drangeabs` (corrected in the same series) align on "Calculate"; the JSDoc, `docs/repl.txt`, and `docs/types/index.d.ts` continue to use the gerund "Computes" (consistent across all 239 packages) and are unchanged.
The `package.json` "description" field began with the imperative verb "Compute". Across the 239 non-aggregator packages in `@stdlib/stats/strided`, 227 (95.0%) use "Calculate" in this field. The `README.md` intro blockquote was already using "Calculate", so only `package.json` is updated to restore consistency between the two human-facing description sources. The non-abs sibling `nanrange` and same-suffix sibling `rangeabs` both say "Calculate"; JSDoc, `docs/repl.txt`, and `docs/types/index.d.ts` continue to use the gerund "Computes" and are unchanged.
The `package.json` "description" field and `README.md` intro blockquote previously began with the imperative verb "Compute". Across the 239 non-aggregator packages in `@stdlib/stats/strided`, 227 (95.0%) use "Calculate" in these fields. The non-abs sibling `dmidrange` and the generic abs sibling `midrangeabs` both say "Calculate"; the JSDoc, `docs/repl.txt`, and `docs/types/index.d.ts` continue to use the gerund "Computes" (consistent across all 239 packages) and are unchanged.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
May 27, 2026
Calculate verb in five stats/strided/*abs package descriptionsstats/strided/*abs package descriptions
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:
"Compute"with"Calculate"in thepackage.json"description"field andREADME.mdintro blockquote of five*abspackages in@stdlib/stats/strided, aligning them with the convention used by 227/239 (95.0%) non-aggregator sibling packages in the namespace.Namespace summary
@stdlib/stats/strideddistancesnamespace aggregator, which is structurally distinct — same exclusion as PR docs: align JS API subheadings to H4 instats/strided/dnanrangeabs#11957)package.jsonshape (top-level keys,scripts,stdlib,keywords, description verb),manifest.jsonshape, README H2/H3/H4 heading sequences,test/,benchmark/,examples/file-name patternspackage.jsontop-level key set (19 keys at 100%), ninekeywordsstrings at 100% (array,math,mathematics,statistics,stats,stdlib,stdmath,strided,strided array), three universal H2 sections (Usage,Notes,Examples— 100%),## See Also(83.7%, auto-populated → excluded),"Calculate"description verb (95.0%)## ReferencesH2 (38.1% — math-references-dependent),keywords: typed(85.8% namespace-wide but a near-50/50 split within the no-prefix generic sub-group, indicating undecided sub-group convention rather than drift), various H3/H4 sub-heading sequences (no single sequence ≥75%)Outlier corrections
@stdlib/stats/strided/drangeabsAligns the
package.jsondescriptionfield andREADME.mdintro blockquote of@stdlib/stats/strided/drangeabswith the"Calculate"verb used by 227 of 239 (95%) sibling packages understats/strided, matching direct analoguesdrangeandrangeabs. The package was one of five outliers — all*absvariants — retaining the non-standard"Compute"prefix. JSDoc,docs/repl.txt, anddocs/types/index.d.tsare unchanged, as"Computes"remains the correct gerund form for machine-readable documentation across the entire sibling set.@stdlib/stats/strided/dnanrangeabsAligns the
package.jsondescription andREADME.mdintroductory blockquote with the established"Calculate"verb used by 227 of 239 (95%) packages instats/strided, replacing the non-conforming"Compute". Sibling packagesdnanrangeandnanrangeabsboth use"Calculate";dnanrangeabswas one of five remaining outliers. Internal JSDoc,docs/repl.txt, anddocs/types/index.d.tsretain their existing gerund form and were not modified.@stdlib/stats/strided/srangeabsReplaces
"Compute"with"Calculate"in thepackage.jsondescription field and theREADME.mdintroductory blockquote for@stdlib/stats/strided/srangeabs. This aligns the package with the 227/239 (95%) majority convention amongstats/stridednon-aggregator packages and matches the wording used by direct siblingssrange,drangeabs, andrangeabs. JSDoc,docs/repl.txt, anddocs/types/index.d.tsretain their existing"Computes"gerund form, which is consistent across all 239 packages and is unchanged.@stdlib/stats/strided/nanrangeabsUpdates the
package.jsondescription verb from"Compute"to"Calculate"to match the README intro, which already read"Calculate the range of …"— making this the only package in the corrected set where the fix ispackage.json-only. The change brings the description into conformance with thenanrangeandrangeabssiblings and with 227 of 239 (95%)stats/stridednon-aggregator packages that use"Calculate"as the leading verb. JSDoc,docs/repl.txt, anddocs/types/index.d.tswere not touched, as those sources use the gerund"Computes"consistently across all 239 packages.@stdlib/stats/strided/dmidrangeabsReplaces
"Compute"with"Calculate"inpackage.jsonand theREADME.mdintro blockquote, the only two surface areas that varied from the prevailing verb acrossstats/strided. Of 239 non-aggregator packages in that namespace, 227 (95%) open theirpackage.jsondescription with"Calculate";dmidrangeabswas one of five outliers. JSDoc,docs/repl.txt, anddocs/types/index.d.tsuse the gerund"Computes"throughout and are unchanged, consistent with the convention shared by all 239 packages.Validation
Three independent validation agents reviewed each outlier before any patch was applied:
lib/main.js,lib/ndarray.js, andREADME.mdin full and compared against non-abs siblings (drange,dnanrange,srange,nanrange,dmidrange) and generic-abs siblings (rangeabs,midrangeabs). Result for all 5:confirmed-drift. Each outlier is a structurally simple per-element absolute-value variant of its non-abs sibling; no multi-array, no statistical-procedure semantics that would warrant the"Compute"verb. The 7 other"Compute"packages in the namespace —ztest,ztest2,dztest,dztest2,sztest,sztest2,dcovmatmtk— were identified as intentional deviations (statistical-test and matrix-multi-array conventions) and were not corrected.test/,examples/,benchmark/,docs/repl.txt,docs/types/, and the widerlib/node_modules/@stdlib/tree for any test, snapshot, REPL fixture, or sibling-package documentation that references the literal"Compute"description text. Result for all 5:safe-to-fix.examples/c/example.cfiles contain unrelated// Compute the range:C inline comments outside the touched lines;docs/repl.txtanddocs/types/index.d.tsuse the gerund"Computes"(separate string, separate convention, untouched). The parentstats/strided/README.mdTOC is regenerated frompackage.jsonand re-syncs automatically."Compute"appears exactly once in eachpackage.json(the description line) and exactly once in eachREADME.mdprose (the line-23 intro blockquote), exceptnanrangeabswhere the README already said"Calculate". All 7 sibling reference packages (drange,srange,nanrange,rangeabs,midrangeabs,dmidrange,dnanrange) confirmed to use"Calculate the …". Result for all 5:confirmed-drift.Deliberately excluded
## See AlsoH2 section missing in 39 packages (83.7% conformance) — auto-populated by the package-generator (<!-- Section for related stdlib packages. Do not manually edit this section, as it is automatically populated. -->); gate 7a forbids manual edits.keywords: typedmissing in 34 generic-prefix packages (85.8% namespace-wide conformance) — within the no-prefix generic sub-group, the rate is 31/65 withtypedand 34/65 without (47.7% / 52.3%), with no semantic axis distinguishing the two halves (maxomits butmskmaxcarries;meanomits butvariancecarries). The namespace-wide majority is dominated by the typed-array-specific packages; the convention within the generic sub-group is undecided. Logged as a candidate for a future targeted standardization run."Compute"packages —ztest/ztest2/dztest/dztest2/sztest/sztest2/dcovmatmtk— are intentional deviations using domain-conventional terminology (hypothesis testing, covariance matrix) and were not corrected.binding.gyp,manifest.json,lib/native.js,src/, etc.) — presence at 69.0%, below threshold; tracks whether a C implementation exists.stats/strided/dnanrangeabs#11957 fordnanrangeabsheading levels.Related Issues
No.
Questions
No.
Other
package.jsondescription +README.mdintro blockquote for 4 packages,package.jsondescription only fornanrangeabs(its README already used"Calculate").package.json.descriptionand theREADME.mdintro blockquote are the only surface areas touched.philipp/drift-stats-strided-2026-05-27.~/drift-reports/drift-stats-strided-2026-05-27.mdoutside the repo working tree.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code running the cross-package API drift detection routine: structural feature extraction across all 239 non-aggregator
@stdlib/stats/stridedpackages, three independent validation agents (semantic-review, cross-reference, structural-review) per outlier, and a final per-package PR-body refinement pass. Each patch is a one-line verb change to a human-facing documentation field; no code, signatures, types, tests, examples, benchmarks, or REPL fixtures were changed. A human will audit before promoting from draft.@stdlib-js/reviewers
Generated by Claude Code