Skip to content

docs: follow-up fixes for commits merged to develop on 2026-05-24#12265

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-05-24
May 24, 2026
Merged

docs: follow-up fixes for commits merged to develop on 2026-05-24#12265
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-05-24

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Follow-up fixes for commits merged to develop between 2026-05-24 01:23 PT (f8a43f95e) and 2026-05-24 05:54 ET (40dad68e6).

Description

This pull request:

  • Cleans up three high-signal documentation defects introduced by commits merged to develop in the last 24 hours. Two are broken equation image paths in the new blas/base/ndarray/dznrm2 and blas/base/ndarray/scnrm2 packages, and one is a typed-array constructor capitalization typo in array/float64's See Also block.

Fixes by package

array/float64

  • Fix capitalization of Float16Array in the @stdlib/array/float16 See Also entry in lib/node_modules/@stdlib/array/float64/README.md; introduced in da0bf4e0, the description used float16Array. instead of Float16Array., inconsistent with every other typed-array sibling in the list.

blas/base/ndarray/dznrm2

  • Fixes a broken equation image in lib/node_modules/@stdlib/blas/base/ndarray/dznrm2/README.md (introduced in 0c071d9e) where the <img src> path incorrectly references @stdlib/blas/base/dznrm2/docs/img/equation_l2_norm.svg instead of the correct @stdlib/blas/base/ndarray/dznrm2/docs/img/equation_l2_norm.svg.

blas/base/ndarray/scnrm2

  • Fixes broken equation image in lib/node_modules/@stdlib/blas/base/ndarray/scnrm2/README.md (introduced in 0c071d9e): the <img src> path pointed to @stdlib/blas/base/scnrm2/docs/img/equation_l2_norm.svg instead of @stdlib/blas/base/ndarray/scnrm2/docs/img/equation_l2_norm.svg.

Related Issues

None.

Questions

No.

Other

Validation

What was checked across the 12 commits in the window (f8a43f95e..40dad68e6):

  • stdlib JavaScript style-guide compliance for changed lib/, test/, benchmark/, examples/, docs/, and .d.ts files.
  • Obvious-bug scan over each diff (wrong variable, off-by-one, mismatched argument count, mislabelled parameter, broken identifier resolution).
  • Logic/security scan over the changed code (wrong formula, swapped arguments, broken invariants, demonstrably wrong examples).
  • Verification of every surviving finding by re-reading the file at the merged SHA before applying a fix.

Deliberately excluded:

  • Anything requiring interpretation, judgement calls, or context outside the window's diff.
  • Style suggestions not codified in docs/style-guides.
  • Findings reported by only one reviewer that could not be independently re-verified from the diff.
  • The blas/base/drotm/test/test.ndarray.js whitespace change was flagged but rejected: that change is the deliberate intent of upstream commit dc7c32d50 (style: fix spacing in multiline arrays).

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 prepared by Claude Code. Multiple reviewer agents independently audited the last 24 hours of merges to develop; only findings that survived cross-agent corroboration and direct file re-verification were applied. Each fix is a one-line edit; the maintainer should still audit before promoting out of draft.


@stdlib-js/reviewers


Generated by Claude Code

@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
array/float64 $\color{green}117/117$
$\color{green}+100.00%$
$\color{red}6/7$
$\color{green}+85.71%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}117/117$
$\color{green}+100.00%$
blas/base/ndarray/dznrm2 $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\color{green}+100.00%$
blas/base/ndarray/scnrm2 $\color{green}103/103$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}103/103$
$\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 24, 2026 19:41
@kgryte kgryte requested a review from a team May 24, 2026 19:41
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 24, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 24, 2026
@kgryte kgryte merged commit 6742bc8 into develop May 24, 2026
53 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-05-24 branch May 24, 2026 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants