docs: align package.json descriptions with imperative-mood convention#12431
Merged
Conversation
Propagates fix from fa63e96 ("docs: fix descriptions") to sibling packages whose `package.json` description field still uses the third-person singular form, mismatching both the package's own README intro and the dominant stdlib convention (700+ "Compute ", 467 "Test ", 490 "Return " imperative-mood descriptions; only three third-person outliers remain after this commit).
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jun 1, 2026
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
Propagating fixes merged to
developbetweenafb44ae(2026-05-31 15:54 -0500) andd2f751e(2026-06-01 04:32 -0700) to sibling packages exhibiting the same defect.docs: fix descriptions(fa63e96): thepackage.jsondescriptionfield began with a third-person singular verb form ("Finds the…") rather than the imperative form ("Find the…") used in the package's own README intro and in the overwhelming majority (1700+) of stdlibpackage.jsondescriptions. The same defect remains in three sibling packages, each of which already uses the imperative form in its README and in adjacent siblingpackage.jsondescriptions:blas/base/cgemv("Performs" → "Perform"; siblingssgemv,dgemv,sgemm,dgemmall use "Perform")ndarray/with("Returns" → "Return"; siblingsat,copy,concat,fill,filter,sliceall use the imperative form)string/base/distances/levenshtein("Calculates" → "Calculate"; siblingstring/base/distances/hamminguses "Calculate the Hamming distance…")Related Issues
No.
Questions
No.
Other
Validation. Source-commit window enumerated with
git log --since="24 hours ago" --first-parent develop(36 commits). Candidates filtered to fixes with a concretely specifiable propagation signature:da8dc3bf(multidimensionalmapNdcallbackindex: number→indices: Array<number>),fa63e96(this),afb44ae0(quantileC API heading parameter name), and0e3aa564(t.deepEqualon complex arrays). Three of the four patterns yielded zero remaining candidates after sibling-package search — the original commits had already covered every site within scope. The fourth pattern (fa63e96) yielded six third-personpackage.jsondescription outliers stdlib-wide; three were rejected because their package's own README also uses third-person form, so changing onlypackage.jsonwould create internal inconsistency.Each surviving site was confirmed by two independent opus validation agents (defect present, fix is a direct analog of
fa63e96, README and sibling-package convention both imperative) and a sonnet style-consistency agent (patch preserves indentation, quote style, and trailing comma; result reads grammatically as an imperative sentence).Deliberately excluded:
math/base/special/hyp2f1("Evaluates"),math/base/special/gammasgnf("Computes"),object/none-own-by("Tests") — each package's README intro also uses the third-person form, so changing onlypackage.jsonwould introduce a new mismatch. Fold into a future README+package.jsoncleanup rather than this propagation.@returnsdescriptions and quantile-README C API heading subpatterns — zero remaining matches under the in-scope search acrosslib/node_modules/@stdlib/.developon 2026-05-31 #12430 (same source-commit window) already coversigamax,isamax,idamax, andrfftifollow-ups; this PR does not touch any file it modifies.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of an automated routine that scans recent fixes merged to
developand propagates equivalent corrections to sibling packages. A sonnet agent specified each source commit's fix pattern; structural searches enumerated candidate sites; two independent opus validators and a sonnet style-consistency agent reviewed each site against the target file and sibling-package conventions. Only sites confirmed by every agent were applied. A maintainer should audit before promoting from draft.@stdlib-js/reviewers
Generated by Claude Code