Skip to content

chore: propagate blas/* JSDoc and cscal header fixes to siblings#12318

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-propagation-2026-05-27
May 27, 2026
Merged

chore: propagate blas/* JSDoc and cscal header fixes to siblings#12318
kgryte merged 3 commits into
developfrom
philipp/fix-propagation-2026-05-27

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between 2026-05-26 13:11 UTC and 2026-05-27 13:11 UTC to sibling packages.

blas/* scalar JSDoc descriptors

Propagates JSDoc fixes from 95a8c41a ("fix: use correct argument value in error message and propagate JSDoc fixes to sibling packages") to remaining blas/* packages where @param descriptors for alpha, beta, and related scalar arguments still read scalar rather than scalar constant. The fix is mechanical: every matching JSDoc line in the affected packages under blas/base, blas/base/wasm, and blas/ext/base has the trailing scalar replaced with scalar constant to align with the established convention.

Source: 95a8c41a

Target packages:

  • blas/base/daxpy
  • blas/base/dscal
  • blas/base/gaxpy
  • blas/base/saxpy
  • blas/base/sscal
  • blas/base/wasm/cscal
  • blas/base/wasm/daxpy
  • blas/base/wasm/dscal
  • blas/base/wasm/saxpy
  • blas/base/wasm/sscal
  • blas/base/wasm/zscal
  • blas/ext/base/sfill

Missing min_view_buffer_index.h include and stale header description

Propagates fixes from 7d900094 ("fix: import src utility and fix description in blas/base/cscal"), which corrected a missing stdlib/strided/base/min_view_buffer_index.h include in the cblas C source and a stale cblas_ccopy reference in the cblas header. blas/base/caxpy receives both corrections — the missing include in caxpy_cblas.c and the wrong cblas_ccopy description in caxpy_cblas.h; blas/base/zscal receives only the missing include fix in zscal_cblas.c, as its header description is already correct.

Source: 7d900094

Target packages:

  • blas/base/caxpy
  • blas/base/zscal

Misclassified VARIABLES section header

Propagates the fix from 4ed822d3 ("docs: follow-up fixes for commits merged to develop on 2026-05-26"), which corrected // VARIABLES // section headers that contained only require() calls to // MODULES //. The same misclassification was present in blas/ext/base/dapx (lib/dapx.js) and ndarray/find-last (lib/callback_wrapper.js), neither of which had a preceding // MODULES // section. Both headers are renamed accordingly.

Source: 4ed822d3

Target packages:

  • blas/ext/base/dapx
  • ndarray/find-last

Related Issues

None.

Questions

No.

Other

Validation

  • Each source commit was specified into a pattern with a concrete search signature, then candidate sites were enumerated under the in-scope namespaces (blas/*, ndarray/*) via rg and verified individually before patching.
  • Per-site verification: each target file was read in full to confirm the defect is present (e.g., that a // VARIABLES // block contains only require() calls and lacks a preceding // MODULES // section; that a cblas C source actually calls stdlib_strided_min_view_buffer_index() without the corresponding header include; that the BLAS JSDoc line uses the bare scalar descriptor in a @param alpha/@param beta slot).
  • Style consistency: replacements preserve indentation, leading * JSDoc markers, and surrounding lines verbatim. No unrelated lines were touched.
  • Deliberately excluded:
    • assert/* candidates for the "Return a boolean indicating" → "Boolean indicating" pattern from 95a8c41a — the source fix applied to a module exporting a constant boolean, whereas the matching signbit/is-buffer-length-compatible* modules export functions, so the original wording is grammatically correct at those sites.
    • @returns input array@returns \x`from4ed822d` — too broad a scope and a stylistic convention rather than a defect; defer to a dedicated cleanup PR.
    • The chisquare doc example variable rename from fdcf93d0 — site-specific and not present at sibling distribution packages.
    • The time/iso-weeks-in-year Notes section from 3b5ee6b3 — single-package documentation, no clear sibling target.
    • The bernoulli/mgf isProbability inline refactor from 3c1e93d7 — adaptive and would require cross-package judgment; deferred.
    • The stats/strided/*abs "Compute" → "Calculate" descriptor refresh from ba77943b — descriptor choice is per-package and not uniformly converged across stats/strided/*.

Checklist

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 PR was authored by Claude Code as part of a routine fix-propagation pass over commits merged to develop in the prior 24 hours. Source commits were identified mechanically; candidate sites were enumerated by rg over a per-pattern search signature, then individually validated by reading each target file in full before patching. All patches are direct, self-contained analogs of the cited source commits.


@stdlib-js/reviewers


Generated by Claude Code

claude added 3 commits May 27, 2026 13:19
Propagates fix from 4ed822d ("docs: follow-up fixes for commits merged
to `develop` on 2026-05-26") to sibling packages where a section
comment incorrectly labels `require()` declarations as `VARIABLES`
rather than `MODULES`.
Propagates fix from 95a8c41 ("fix: use correct argument value in error
message and propagate JSDoc fixes to sibling packages") to remaining
BLAS routines where `alpha` and `beta` JSDoc parameter descriptions
still use `scalar` rather than `scalar constant`.
…nd `zscal`

Propagates fix from 7d90009 ("fix: import `src` utility and fix
description in `blas/base/cscal`") to BLAS Level 1 packages with the
same defects: `caxpy_cblas.c` and `zscal_cblas.c` invoke
`stdlib_strided_min_view_buffer_index()` without including
`stdlib/strided/base/min_view_buffer_index.h`, and the `caxpy_cblas.h`
header description still references `cblas_ccopy` instead of
`cblas_caxpy`.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/base/caxpy $\color{green}368/368$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}368/368$
$\color{green}+100.00%$
blas/base/daxpy $\color{green}420/420$
$\color{green}+100.00%$
$\color{green}30/30$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}420/420$
$\color{green}+100.00%$
blas/base/dscal $\color{green}389/389$
$\color{green}+100.00%$
$\color{green}26/26$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}389/389$
$\color{green}+100.00%$
blas/base/gaxpy $\color{green}307/307$
$\color{green}+100.00%$
$\color{green}25/25$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}307/307$
$\color{green}+100.00%$
blas/base/saxpy $\color{green}425/425$
$\color{green}+100.00%$
$\color{green}30/30$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}425/425$
$\color{green}+100.00%$
blas/base/sscal $\color{green}389/389$
$\color{green}+100.00%$
$\color{green}26/26$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}389/389$
$\color{green}+100.00%$
blas/base/wasm/cscal $\color{green}694/694$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}694/694$
$\color{green}+100.00%$
blas/base/wasm/daxpy $\color{green}637/637$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}637/637$
$\color{green}+100.00%$
blas/base/wasm/dscal $\color{green}604/604$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}604/604$
$\color{green}+100.00%$
blas/base/wasm/saxpy $\color{green}637/637$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}637/637$
$\color{green}+100.00%$
blas/base/wasm/sscal $\color{green}608/608$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}608/608$
$\color{green}+100.00%$
blas/base/wasm/zscal $\color{green}694/694$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}694/694$
$\color{green}+100.00%$
blas/base/zscal $\color{green}400/400$
$\color{green}+100.00%$
$\color{green}17/17$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}400/400$
$\color{green}+100.00%$
blas/ext/base/dapx $\color{green}388/388$
$\color{green}+100.00%$
$\color{green}26/26$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}388/388$
$\color{green}+100.00%$
blas/ext/base/sfill $\color{green}391/391$
$\color{green}+100.00%$
$\color{green}26/26$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}391/391$
$\color{green}+100.00%$
ndarray/find-last $\color{green}416/416$
$\color{green}+100.00%$
$\color{green}44/44$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}416/416$
$\color{green}+100.00%$

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

@Planeshifter Planeshifter changed the title fix: propagate blas/* JSDoc and cscal header fixes to siblings chore: propagate blas/* JSDoc and cscal header fixes to siblings May 27, 2026
@Planeshifter Planeshifter marked this pull request as ready for review May 27, 2026 16:40
@Planeshifter Planeshifter requested review from a team and kgryte May 27, 2026 16:40
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 27, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label May 27, 2026
@kgryte kgryte merged commit 8ff59d6 into develop May 27, 2026
41 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-05-27 branch May 27, 2026 19:42
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.

4 participants