Skip to content

docs: fix offset parameter wording in multi-offset READMEs#12243

Draft
Planeshifter wants to merge 1 commit into
developfrom
philipp/fix-propagation-2026-05-22
Draft

docs: fix offset parameter wording in multi-offset READMEs#12243
Planeshifter wants to merge 1 commit into
developfrom
philipp/fix-propagation-2026-05-22

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Propagating fixes merged to develop between 6615546b (2026-05-21 16:53 -0700) and 6e874c29c (2026-05-21 17:02 -0700) to sibling packages.

Pattern: pluralize offset parameter wording in multi-offset READMEs

Commit 8441545518 corrected singular offset-parameter wording in the blas/ext/base/*sort2* READMEs, where the prose read "the offset parameter supports ... a starting index" despite the documented ndarray API exposing two distinct offset parameters. The same defect is present in three sibling READMEs that likewise document two distinct offsets — offsetX/offsetY for the sort functions and offsetX/offsetOut for dmeanvarpn. 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).

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

Reviewed all commits merged to develop in the 24-hour window. One propagatable source pattern advanced to the patch stage:

  • Search scope: scoped first to the source commit's namespace (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.
  • Two independent opus validation passes confirmed each target function exposes two distinct offset parameters and that the singular phrasing is genuinely defective.
  • An adaptation pass produced the per-site wording: dsort2hp/dsort2sh adopt the blas/ext/base/*sort2* form (no leading "the", backticked buffer), while dmeanvarpn keeps the stats/strided family form (leading "the", unbackticked buffer) and corrects only the singular tail.
  • A style-consistency pass confirmed each corrected line matches its already-correct sibling character-for-character.

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.
  • The typo and error corrections bundled in 6615546b (test: correct typos and errors in blas/ext/base/dediff — e.g. strides lengthstride length, eigtheighth): the source commit fixed the only occurrences present in the tree, leaving no sibling sites.
  • The 393 single-offset README files containing the singular offset phrasing: the singular wording is correct for functions with one offset parameter.

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 PR was authored by Claude Code on behalf of @Planeshifter as an automated propagation of fixes merged to develop over 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

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

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/dsort2hp $\color{green}631/631$
$\color{green}+100.00%$
$\color{green}67/67$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}631/631$
$\color{green}+100.00%$
blas/ext/base/dsort2sh $\color{green}543/543$
$\color{green}+100.00%$
$\color{green}53/53$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}543/543$
$\color{green}+100.00%$
stats/strided/dmeanvarpn $\color{green}441/441$
$\color{green}+100.00%$
$\color{green}28/28$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}441/441$
$\color{green}+100.00%$

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants