Skip to content

docs: fix wording in dswap notes for blas/base/ndarray#11797

Merged
kgryte merged 1 commit intodevelopfrom
philipp/fix-commit-review-2026-04-26
Apr 27, 2026
Merged

docs: fix wording in dswap notes for blas/base/ndarray#11797
kgryte merged 1 commit intodevelopfrom
philipp/fix-commit-review-2026-04-26

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

@Planeshifter Planeshifter commented Apr 26, 2026

Description

Follow-up fix for commits merged to develop between 2026-04-25T16:41:07-07:00 and 2026-04-26T05:11:55-07:00 (SHA range 9135c0356..2e347f39e, 31 first-parent commits).

This pull request:

  • blas/base/ndarray — Fix missing "a" articles in dswap Notes block bullets introduced in be8badf (lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts, lines 219–220); entries read "first one-dimensional input ndarray." and "second one-dimensional input ndarray." instead of "a first one-dimensional input ndarray." and "a second one-dimensional input ndarray." consistent with every other entry in the same sweep.

Related Issues

No.

Questions

No.

Other

Validation performed across the 24h commit window:

  • Style guide compliance (docs/style-guides/) — checked all newly added packages (ndarray/{rot180,rotl90,to-rot90,to-rotr90,unflatten,ndarraylike2scalar,base/to-rot180,base/to-rotl90}, blas/ext/base/ndarray/{dunitspace,sunitspace,cunitspace,zunitspace,gunitspace}) against their reference peers.
  • Bug scan — diff-only review of all 31 commits for objective runtime bugs, cross-family copy-paste errors in the d/s/c/z/g unitspace variants, format-string arity mismatches, and ULP test-tolerance correctness.

Deliberately excluded:

  • Subjective concerns or "could be cleaner" suggestions.
  • Anything requiring code outside the diff window to validate.
  • Style preferences not encoded in docs/style-guides/.
  • Boilerplate intentionally shared across the rotation and unitspace families.

Originally also included a wording change to ndarray/ndarraylike2scalar's TypeError message; reverted per @kgryte — single-argument APIs use the "Must provide an ndarray" form (cf. ndarray/data-buffer, ndarray/dtype), and the multi-argument "First argument must be..." references the audit picked were not analogous.

Checklist

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 as a follow-up sweep over commits merged to develop in the last 24 hours; reviewer agents flagged candidate issues, each was independently re-verified against the diff and reference peers, and only validated high-signal fixes were applied. A maintainer should still audit before promoting from draft.


@stdlib-js/reviewers

@Planeshifter Planeshifter changed the title Follow-up fixes for develop commits merged 2026-04-25..2026-04-26 docs: fix wording in blas/base/ndarray and ndarray/ndarraylike2scalar Apr 26, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Apr 26, 2026

Coverage Report

Package Statements Branches Functions Lines
blas/base/ndarray $\color{red}2052/2150$
$\color{green}+0.00%$
$\color{green}35/35$
$\color{green}+0.00%$
$\color{red}0/17$
$\color{green}+0.00%$
$\color{red}2052/2150$
$\color{green}+0.00%$

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

Comment thread lib/node_modules/@stdlib/ndarray/ndarraylike2scalar/lib/main.js Outdated
Other entries added in the same TS-declarations sweep use "a first
one-dimensional input ndarray." / "a second one-dimensional input
ndarray."; bring the dswap entry in line.
@Planeshifter Planeshifter force-pushed the philipp/fix-commit-review-2026-04-26 branch from dd27b28 to d5fdcc9 Compare April 26, 2026 23:02
@Planeshifter Planeshifter changed the title docs: fix wording in blas/base/ndarray and ndarray/ndarraylike2scalar docs: fix wording in dswap notes for blas/base/ndarray Apr 26, 2026
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Apr 26, 2026
@kgryte kgryte marked this pull request as ready for review April 26, 2026 23:04
@kgryte kgryte requested a review from a team April 26, 2026 23:04
@stdlib-bot stdlib-bot added BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). Needs Review A pull request which needs code review. labels Apr 26, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 27, 2026
@kgryte kgryte merged commit 6ba8e82 into develop Apr 27, 2026
70 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-04-26 branch April 27, 2026 03:37
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