Skip to content

docs: propagate recent doc-note and grammar fixes to sibling packages#12193

Merged
kgryte merged 2 commits into
developfrom
claude/wonderful-planck-O2zvq
May 19, 2026
Merged

docs: propagate recent doc-note and grammar fixes to sibling packages#12193
kgryte merged 2 commits into
developfrom
claude/wonderful-planck-O2zvq

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Propagating fixes merged to develop between 2026-05-17 and 2026-05-18 to sibling packages carrying the same defect.

blas/ext/base/*index-of-column — incorrect return-value note

Commit a6856ed70 ("docs: update notes") corrected the ## Notes bullet in cindex-of-column and zindex-of-column, which claimed the function returns -1 when "unable to find a search vector". The search vector is a required input and is always present; the function returns -1 when it cannot locate a matching column. The identical wording was present, verbatim, in the JSDoc and TypeScript declarations of two sibling packages:

  • blas/ext/base/gindex-of-column
  • blas/ext/base/sindex-of-column

dindex-of-column already carried the corrected wording and is left untouched.

ndarray/empty-like — grammar in a test description

Commit 435de1206 ("test: fix grammar in description") fixed a singular/plural disagreement in a nans-like test description (array having shapesarrays having shapes). One sibling package carried the identical defect:

  • ndarray/empty-like

Every other *-like ndarray package (zeros-like, ones-like, trues-like, falses-like, nans-like) already used the plural form.

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request?

Validation. Each pattern was searched across its in-scope namespace (blas/ext/base/*index-of-column for the note wording; ndarray/*-like test descriptions for the grammar fix). Two independent reviewers verified every candidate site by reading the target files in full, confirming the defect is present and the corrected wording matches the source commit verbatim. The note-wording replacement is anchored on a trailing comma, so it cannot affect the legitimate "search vector" references in @param descriptions and algorithm comments.

Deliberately excluded. Test-description occurrences of "search vector" in the *index-of-column packages — the source commit a6856ed70 scoped its change to JSDoc and TypeScript declarations only, and this PR mirrors that scope; dindex-of-column, already corrected; and cindex-of-column / zindex-of-column, the originating packages. No sites required cross-package changes or adaptive rework.

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 pull request was authored by an automated fix-propagation routine running on Claude Code. The routine identifies recently merged fixes, locates sibling packages with the same defect, and applies the equivalent change; each propagation site was verified by independent automated review before inclusion.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits May 18, 2026 13:26
Propagates fix from a6856ed ("docs: update notes") to sibling
index-of-column packages. The JSDoc and TypeScript notes incorrectly
stated the function returns `-1` when "unable to find a search vector"
rather than "unable to find a matching column"; the search vector is an
always-provided input, so the function instead fails to locate a
matching column.
Propagates fix from 435de12 ("test: fix grammar in description") to a
sibling -like package having the same singular/plural disagreement
("array" vs. "arrays") in a test description.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/gindex-of-column $\color{green}555/555$
$\color{green}+100.00%$
$\color{green}58/58$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}555/555$
$\color{green}+100.00%$
blas/ext/base/sindex-of-column $\color{green}531/531$
$\color{green}+100.00%$
$\color{green}52/52$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}531/531$
$\color{green}+100.00%$
ndarray/empty-like $\color{green}206/206$
$\color{green}+100.00%$
$\color{green}31/31$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}206/206$
$\color{green}+100.00%$

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

@kgryte kgryte marked this pull request as ready for review May 19, 2026 05:56
@kgryte kgryte requested a review from a team May 19, 2026 05:56
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 19, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 19, 2026
@kgryte kgryte merged commit 2384460 into develop May 19, 2026
53 checks passed
@kgryte kgryte deleted the claude/wonderful-planck-O2zvq branch May 19, 2026 05:57
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