docs: fix offset parameter wording in multi-offset READMEs#12243
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: fix offset parameter wording in multi-offset READMEs#12243Planeshifter wants to merge 1 commit into
Planeshifter wants to merge 1 commit into
Conversation
Propagates the offset parameter wording fix from 8441545 ("docs: fix offset parameter wording in blas/ext/base/*sort2* READMEs") to sibling README files for strided functions that expose multiple distinct offset parameters. Each affected function documents two offset parameters, so the prose now uses plural phrasing ("offset parameters support indexing semantics based on starting indices") consistent with already-corrected siblings. Ref: 8441545
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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
developbetween6615546b(2026-05-21 16:53 -0700) and6e874c29c(2026-05-21 17:02 -0700) to sibling packages.Pattern: pluralize offset parameter wording in multi-offset READMEs
Commit
8441545518corrected singular offset-parameter wording in theblas/ext/base/*sort2*READMEs, where the prose read "the offset parameter supports ... a starting index" despite the documentedndarrayAPI exposing two distinct offset parameters. The same defect is present in three sibling READMEs that likewise document two distinct offsets —offsetX/offsetYfor the sort functions andoffsetX/offsetOutfordmeanvarpn. Each receives the analogous one-line correction, pluralizing the clause to "offset parameters support ... starting indices" to match the wording already used by their corrected siblings (dsort2ins,ssort2hp,ssort2sh,dmeanvar).8441545518(docs: fix offset parameter wording in blas/ext/base/*sort2* READMEs)@stdlib/blas/ext/base/dsort2hp@stdlib/blas/ext/base/dsort2sh@stdlib/stats/strided/dmeanvarpnRelated Issues
None.
Questions
No.
Other
Validation
Reviewed all commits merged to
developin the 24-hour window. One propagatable source pattern advanced to the patch stage:blas/ext/base/*sort2*) and then widened to all README files repository-wide containing the singular offset phrasing. Of 393 matching files, only those documenting two or more genuinely distinct offset parameters carry the defect; the rest are single-offset functions for which the singular phrasing is correct and were excluded.dsort2hp/dsort2shadopt theblas/ext/base/*sort2*form (no leading "the", backtickedbuffer), whiledmeanvarpnkeeps thestats/stridedfamily form (leading "the", unbacktickedbuffer) and corrects only the singular tail.Deliberately excluded:
dc7c32d5(style: fix spacing in multiline arrays): a purely cosmetic whitespace change with no behavioral, performance, or user-visible text impact; below the high-signal bar.6615546b(test: correct typos and errors in blas/ext/base/dediff— e.g.strides length→stride length,eigth→eighth): the source commit fixed the only occurrences present in the tree, leaving no sibling sites.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code on behalf of @Planeshifter as an automated propagation of fixes merged to
developover the prior 24 hours. Candidate source commits were filtered for generalizable patterns, sibling sites located via grep-able pattern signatures, and each proposed patch independently validated by parallel reviewer agents (two opus validation passes, an adaptation pass, and a style-consistency pass) before commits were applied in the primary worktree. A human will audit and promote the PR out of draft.@stdlib-js/reviewers
Generated by Claude Code