Skip to content

docs: fix offset parameter wording in blas/ext/base/*sort2* READMEs#12229

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-05-21
May 21, 2026
Merged

docs: fix offset parameter wording in blas/ext/base/*sort2* READMEs#12229
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-05-21

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

This pull request propagates a documentation fix merged to develop on 2026-05-20 to sibling packages exhibiting the same defect.

Source commit 618583c83 ("docs: update copy") corrected the @stdlib/blas/ext/base/dediff README, which referred to the package's multiple offset parameters in the singular ("the offset parameter ... a starting index"). The same wording is present in three sort2 sibling packages, each of which documents two offset parameters (offsetX and offsetY):

  • blas/ext/base/dsort2ins
  • blas/ext/base/ssort2hp
  • blas/ext/base/ssort2sh

Each README is updated to the plural phrasing already used by sibling packages such as dediff and ssort2ins.

Related Issues

None.

Questions

No.

Other

Search was scoped to blas/ext/base. Single-offset packages, where the singular phrasing is correct, were deliberately excluded; the three sort2 packages above are the only siblings documenting multiple offset parameters that still used the singular wording. The change is a verbatim string replacement; two independent reviews confirmed each target package documents multiple offset parameters before the change was applied.

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 prepared by an automated fix-propagation routine running with Claude Code. The routine identified the documentation fix in commit 618583c83, located sibling packages with the same wording error, and applied the equivalent correction. Two independent reviews verified each target package documents multiple offset parameters before the change was applied.


@stdlib-js/reviewers


Generated by Claude Code

Propagates the fix from 618583c ("docs: update copy") to sibling
sort2 packages whose READMEs describe multiple offset parameters using
singular phrasing. The dsort2ins, ssort2hp, and ssort2sh packages each
document two offset parameters (offsetX and offsetY) but referred to
"the offset parameter" in the singular; the wording is corrected to the
plural form already used by sibling packages.

Ref: 618583c
@stdlib-bot stdlib-bot added the BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). label May 21, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/dsort2ins $\color{green}666/666$
$\color{green}+100.00%$
$\color{green}74/74$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}666/666$
$\color{green}+100.00%$
blas/ext/base/ssort2hp $\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/ssort2sh $\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%$

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

@kgryte kgryte marked this pull request as ready for review May 21, 2026 23:53
@kgryte kgryte requested a review from a team May 21, 2026 23:53
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. labels May 21, 2026
@kgryte kgryte changed the title docs: fix offset parameter wording in blas/ext/base sort2 READMEs docs: fix offset parameter wording in blas/ext/base/*sort2* READMEs May 21, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 21, 2026
@kgryte kgryte merged commit 8441545 into develop May 21, 2026
91 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-05-21 branch May 21, 2026 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants