Skip to content

docs: align package.json descriptions with imperative-mood convention#12431

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-06-01
Jun 1, 2026
Merged

docs: align package.json descriptions with imperative-mood convention#12431
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-06-01

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between afb44ae (2026-05-31 15:54 -0500) and d2f751e (2026-06-01 04:32 -0700) to sibling packages exhibiting the same defect.

  • docs: fix descriptions (fa63e96): the package.json description field 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 stdlib package.json descriptions. The same defect remains in three sibling packages, each of which already uses the imperative form in its README and in adjacent sibling package.json descriptions:
    • blas/base/cgemv ("Performs" → "Perform"; siblings sgemv, dgemv, sgemm, dgemm all use "Perform")
    • ndarray/with ("Returns" → "Return"; siblings at, copy, concat, fill, filter, slice all use the imperative form)
    • string/base/distances/levenshtein ("Calculates" → "Calculate"; sibling string/base/distances/hamming uses "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 (multidimensional mapNd callback index: numberindices: Array<number>), fa63e96 (this), afb44ae0 (quantile C API heading parameter name), and 0e3aa564 (t.deepEqual on 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-person package.json description outliers stdlib-wide; three were rejected because their package's own README also uses third-person form, so changing only package.json would 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 only package.json would introduce a new mismatch. Fold into a future README+package.json cleanup rather than this propagation.
  • Capitalized JSDoc @returns descriptions and quantile-README C API heading subpatterns — zero remaining matches under the in-scope search across lib/node_modules/@stdlib/.
  • Open follow-up PR chore: address follow-up review findings for commits merged to develop on 2026-05-31 #12430 (same source-commit window) already covers igamax, isamax, idamax, and rffti follow-ups; this PR does not touch any file it modifies.

Checklist

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 as part of an automated routine that scans recent fixes merged to develop and 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

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).
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/base/cgemv $\color{green}845/845$
$\color{green}+100.00\%$
$\color{green}118/118$
$\color{green}+100.00\%$
$\color{green}6/6$
$\color{green}+100.00\%$
$\color{green}845/845$
$\color{green}+100.00\%$
ndarray/with $\color{red}159/161$
$\color{green}+98.76\%$
$\color{red}14/15$
$\color{green}+93.33\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{red}159/161$
$\color{green}+98.76\%$
string/base/distances/levenshtein $\color{green}142/142$
$\color{green}+100.00\%$
$\color{green}18/18$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}142/142$
$\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 June 1, 2026 13:42
@Planeshifter Planeshifter requested review from a team and kgryte June 1, 2026 13:42
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 1, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jun 1, 2026
@kgryte kgryte merged commit f7a08b6 into develop Jun 1, 2026
54 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-06-01 branch June 1, 2026 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants