docs: fix offset parameter wording in blas/ext/base/*sort2* READMEs#12229
Merged
Conversation
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
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
blas/ext/base sort2 READMEsblas/ext/base/*sort2* READMEs
kgryte
approved these changes
May 21, 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
This pull request propagates a documentation fix merged to
developon 2026-05-20 to sibling packages exhibiting the same defect.Source commit
618583c83("docs: update copy") corrected the@stdlib/blas/ext/base/dediffREADME, which referred to the package's multiple offset parameters in the singular ("the offset parameter ... a starting index"). The same wording is present in threesort2sibling packages, each of which documents two offset parameters (offsetXandoffsetY):blas/ext/base/dsort2insblas/ext/base/ssort2hpblas/ext/base/ssort2shEach README is updated to the plural phrasing already used by sibling packages such as
dediffandssort2ins.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 threesort2packages 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
AI Assistance
If you answered "yes" above, how did you use AI assistance?
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