docs: propagate recent doc-note and grammar fixes to sibling packages#12193
Merged
Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
May 19, 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
developbetween 2026-05-17 and 2026-05-18 to sibling packages carrying the same defect.blas/ext/base/*index-of-column— incorrect return-value noteCommit
a6856ed70("docs: update notes") corrected the## Notesbullet incindex-of-columnandzindex-of-column, which claimed the function returns-1when "unable to find a search vector". The search vector is a required input and is always present; the function returns-1when 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-columnblas/ext/base/sindex-of-columndindex-of-columnalready carried the corrected wording and is left untouched.ndarray/empty-like— grammar in a test descriptionCommit
435de1206("test: fix grammar in description") fixed a singular/plural disagreement in anans-liketest description (array having shapes→arrays having shapes). One sibling package carried the identical defect:ndarray/empty-likeEvery other
*-likendarray package (zeros-like,ones-like,trues-like,falses-like,nans-like) already used the plural form.Related Issues
None.
Questions
No.
Other
Validation. Each pattern was searched across its in-scope namespace (
blas/ext/base/*index-of-columnfor the note wording;ndarray/*-liketest 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@paramdescriptions and algorithm comments.Deliberately excluded. Test-description occurrences of "search vector" in the
*index-of-columnpackages — the source commita6856ed70scoped its change to JSDoc and TypeScript declarations only, and this PR mirrors that scope;dindex-of-column, already corrected; andcindex-of-column/zindex-of-column, the originating packages. No sites required cross-package changes or adaptive rework.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
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