Skip to content

docs: follow-up typo fixes for matrix packages and number/uint64/ctor#13151

Draft
Planeshifter wants to merge 7 commits into
developfrom
philipp/fix-commit-review-2026-06-26
Draft

docs: follow-up typo fixes for matrix packages and number/uint64/ctor#13151
Planeshifter wants to merge 7 commits into
developfrom
philipp/fix-commit-review-2026-06-26

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

Follow-up fixes for commits merged to develop between 2026-06-25 19:40 UTC and 2026-06-26 08:21 UTC (SHA range a8789cce9..ba7afec2a, 22 commits reviewed).

This pull request:

  • Fixes a copy-paste typo and twelve propagated documentation issues introduced by the new ndarray/matrix/{float64,float32,complex64,complex128,int32} packages, the ndarray/matrix/ctor README expansion, and the number/uint64/ctor toPrimitive addition.

Fixes by package

number/uint64/ctor

  • Fix @returns description for the lo accessor in lib/node_modules/@stdlib/number/uint64/ctor/docs/types/index.d.ts — copy-pasted from hi, causing it to read "high word" instead of "low word" (a8789cc).

ndarray/matrix/ctor

  • Fix stray space in compound adjective array- likearray-like in ndarray/matrix/ctor/README.md (7ff0456).

ndarray/matrix/complex128

  • Correct the @example for the (buffer, byteOffset, M, N, options?) overload in ndarray/matrix/complex128/docs/types/index.d.ts — copy-pasted from the shape-based overload and erroneously passed [ 2, 1 ] instead of the scalar arguments 2, 1 (6e71938).
  • Fix stray space in compound adjective array- likearray-like in ndarray/matrix/complex128/README.md (56ffe96).

ndarray/matrix/complex64

  • Correct the @example for the (buffer, byteOffset, M, N, options?) overload in ndarray/matrix/complex64/docs/types/index.d.ts — copy-pasted from the shape-based overload and erroneously passed [ 2, 1 ] instead of the scalar arguments 2, 1 (117fe75).
  • Fix stray space in compound adjective array- likearray-like in ndarray/matrix/complex64/README.md (56ffe96).

ndarray/matrix/float32

  • Correct the @example for the (buffer, byteOffset, M, N, options?) overload in ndarray/matrix/float32/docs/types/index.d.ts — copy-pasted from the shape-based overload and erroneously passed [ 2, 1 ] instead of the scalar arguments 2, 1 (d93e3df).
  • Fix stray space in compound adjective array- likearray-like in ndarray/matrix/float32/README.md (56ffe96).

ndarray/matrix/float64

  • Correct the @example for the (buffer, byteOffset, M, N, options?) overload in ndarray/matrix/float64/docs/types/index.d.ts — copy-pasted from the shape-based overload and erroneously passed [ 2, 1 ] instead of the scalar arguments 2, 1 (af1484d).
  • Fix stray space in compound adjective array- likearray-like in ndarray/matrix/float64/README.md (56ffe96).

ndarray/matrix/int32

  • Correct the @example for the (buffer, byteOffset, M, N, options?) overload in ndarray/matrix/int32/docs/types/index.d.ts — copy-pasted from the shape-based overload and erroneously passed [ 2, 1 ] instead of the scalar arguments 2, 1 (03d3cb0).
  • Fix stray space in compound adjective array- likearray-like in ndarray/matrix/int32/README.md (56ffe96).

Related Issues

None.

Questions

No.

Other

Validation

Audited 22 commits merged to develop in the last 24 hours via four parallel reviewers (two style-compliance, two correctness-focused bug scans). Each finding was independently re-verified by reading the modified files before inclusion.

Checked:

  • stdlib code style guide compliance (docs/style-guides/{javascript,c,text})
  • Obvious correctness bugs in the introduced code
  • Documentation that contradicts the implementation it documents
  • Typos in identifiers, user-visible strings, and docs

Deliberately excluded (would have required interpretation or out-of-window changes):

  • Subjective preferences and "could be cleaner" suggestions
  • Concerns whose validation needed touching code outside the 24-hour window
  • One reviewer-flagged "alphabetical-ordering violation" in ndarray/matrix/lib/index.js: dropped after verifying that stdlib's established convention for typed namespaces (see ndarray/vector/lib/index.js) orders type-size digits numerically (Complex64 before Complex128, vector between Complex128 and Float32), so the current order is correct.

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 generated by a scheduled review routine running on Claude Code. The routine enumerated commits merged to develop in the last 24 hours, dispatched four parallel reviewer agents to surface issues, filtered out single-agent findings that could not be independently re-verified by re-reading the diff, and applied only the validated typo fixes listed above. Each fix was re-read after application to confirm it matched the proposed change exactly; no code outside the diff window was touched. Left in draft for human audit.


@stdlib-js/reviewers


Generated by Claude Code

claude added 7 commits June 26, 2026 12:31
…t64/ctor`

The `lo` accessor's JSDoc `@returns` tag was copy-pasted from the
preceding `hi` accessor and incorrectly stated "high word"; corrected
to "low word".

Ref: a8789cc
Removes the stray space splitting the compound adjective in the
`obj` argument description.

Ref: 7ff0456
- Removes stray space in `array-like` in the README `obj` argument
  description.
- Corrects the `(buffer, byteOffset, M, N)` callable overload `@example`,
  which had been copy-pasted from the shape-based overload and was
  passing `[ 2, 1 ]` instead of `2, 1`.

Refs: 6e71938f3, 56ffe96
- Removes stray space in `array-like` in the README `obj` argument
  description.
- Corrects the `(buffer, byteOffset, M, N)` callable overload `@example`,
  which had been copy-pasted from the shape-based overload and was
  passing `[ 2, 1 ]` instead of `2, 1`.

Refs: 117fe75, 56ffe96
- Removes stray space in `array-like` in the README `obj` argument
  description.
- Corrects the `(buffer, byteOffset, M, N)` callable overload `@example`,
  which had been copy-pasted from the shape-based overload and was
  passing `[ 2, 1 ]` instead of `2, 1`.

Refs: d93e3df, 56ffe96
- Removes stray space in `array-like` in the README `obj` argument
  description.
- Corrects the `(buffer, byteOffset, M, N)` callable overload `@example`,
  which had been copy-pasted from the shape-based overload and was
  passing `[ 2, 1 ]` instead of `2, 1`.

Refs: af1484d, 56ffe96
- Removes stray space in `array-like` in the README `obj` argument
  description.
- Corrects the `(buffer, byteOffset, M, N)` callable overload `@example`,
  which had been copy-pasted from the shape-based overload and was
  passing `[ 2, 1 ]` instead of `2, 1`.

Refs: 03d3cb0, 56ffe96
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/matrix/complex128 $\\color{green}253/253$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}253/253$
$\\color{green}+100.00\\%$
ndarray/matrix/complex64 $\\color{green}253/253$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}253/253$
$\\color{green}+100.00\\%$
ndarray/matrix/ctor $\\color{green}1296/1296$
$\\color{green}+100.00\\%$
$\\color{green}255/255$
$\\color{green}+100.00\\%$
$\\color{green}7/7$
$\\color{green}+100.00\\%$
$\\color{green}1296/1296$
$\\color{green}+100.00\\%$
ndarray/matrix/float32 $\\color{green}253/253$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}253/253$
$\\color{green}+100.00\\%$
ndarray/matrix/float64 $\\color{green}253/253$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}253/253$
$\\color{green}+100.00\\%$
ndarray/matrix/int32 $\\color{green}253/253$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}0/0$
$\\color{green}+100.00\\%$
$\\color{green}253/253$
$\\color{green}+100.00\\%$
number/uint64/ctor $\\color{red}585/644$
$\\color{green}+90.84\\%$
$\\color{red}49/52$
$\\color{green}+94.23\\%$
$\\color{red}9/11$
$\\color{green}+81.82\\%$
$\\color{red}585/644$
$\\color{green}+90.84\\%$

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