Skip to content

chore: clean-up - #13978

Merged
kgryte merged 4 commits into
developfrom
philipp/fix-propagation-2026-08-06
Aug 6, 2026
Merged

chore: clean-up#13978
kgryte merged 4 commits into
developfrom
philipp/fix-propagation-2026-08-06

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request propagates fixes merged to develop between 2026-08-05 and 2026-08-06 to sibling packages with the same defects.

JSDoc @function@name (source: 4db26c0)

4db26c0 fixed @stdlib/random/base/chisquare's @function chisquare tag to @name chisquare, since the documented export is a factory-produced PRNG value, not a function declaration. This propagates the same fix to the three remaining outliers in random/base, bringing all 43 packages into consistency:

  • @stdlib/random/base/minstd
  • @stdlib/random/base/minstd-shuffle
  • @stdlib/random/base/mt19937

C const qualifiers (sources: 8ef56c4, ed2034b)

Applies the const qualification from 8ef56c4 and ed2034b to the remaining sibling assert packages that lacked it. Every helper invoked by these functions already declares const-qualified parameters, so no downstream signature changes are required.

  • @stdlib/ndarray/base/assert/is-buffer-length-compatible
  • @stdlib/ndarray/base/assert/is-buffer-length-compatible-shape
  • @stdlib/ndarray/base/assert/is-column-major-contiguous

is-contiguous is excluded. PR #13874 already const-qualifies it.

Benchmark boolean assertion (source: 1935a5f)

Propagates the fix from 1935a5f to @stdlib/assert/deep-equal's benchmark/benchmark.js, replacing require( '@stdlib/assert/is-boolean' ) with require( '@stdlib/assert/is-boolean' ).isPrimitive. The sole isBoolean call site checks deepEqual's return value, which is always a primitive boolean.

README escaped bracket (source: 51e6c83)

Propagates the same README cleanup to the number2words README, the last remaining occurrence of the unnecessary escaped-bracket form in the uint64/base namespace: \[`0`, `2^53-1`\] becomes \[`0`, `2^53-1`], matching the fix already applied to bigint2words in 51e6c83.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Validation performed per pattern: signatures were derived from the source commits and searched across the in-scope namespaces; two independent validation passes confirmed each defect in full-file context; an adaptation pass confirmed each patch is self-contained within its target package (all C helpers called by the modified functions already declare const-qualified parameters, and no external callers reference the three C symbols); and a style-consistency pass confirmed each patch matches the merged precedents.

Deliberately excluded: ndarray/base/assert/is-contiguous (covered by open PR #13874); double-precision pow usage in other *f package fixtures (intentional reference computations, not the 37facc3 defect); shape parameter descriptions in random/base/* validators (all verified correct); and the remaining escaped-bracket occurrences repo-wide (literal regexp output and CLI-syntax contexts where the escape is intended).

Checklist

Please ensure the following tasks are completed before submitting this pull request.

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was authored by Claude Code as part of an automated fix-propagation routine: candidate sites were located by pattern search over the last 24 hours of develop commits, and every applied patch was confirmed by two independent validation passes plus adaptation and style-consistency passes before committing.


@stdlib-js/reviewers


Generated by Claude Code

claude added 4 commits August 6, 2026 13:29
Propagates fix from 4db26c0 ("docs: fix inconsistent JSDoc annotations")
to sibling packages documenting a factory-produced PRNG with `@function`
instead of `@name`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014AQwLfUnMjo4hyfgxsZRg2
Propagates fixes from 8ef56c4 ("refactor: add `const` qualifiers") and
ed2034b ("chore: fix C lint errors") to sibling packages whose C function
signatures lack `const` qualifiers on read-only parameters.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014AQwLfUnMjo4hyfgxsZRg2
Propagates fix from 1935a5f ("chore: clean-up") to a sibling benchmark
asserting a primitive boolean return value via `assert/is-boolean`
instead of `assert/is-boolean` `isPrimitive`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014AQwLfUnMjo4hyfgxsZRg2
Propagates fix from 51e6c83 ("docs: update note") to the sibling package
with the same needlessly escaped closing bracket in its interval-range
note.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014AQwLfUnMjo4hyfgxsZRg2
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
assert/deep-equal $\\color{green}178/178$
$\\color{green}+100.00\\%$
$\\color{green}36/36$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}178/178$
$\\color{green}+100.00\\%$
ndarray/base/assert/is-buffer-length-compatible $\\color{green}118/118$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}118/118$
$\\color{green}+100.00\\%$
ndarray/base/assert/is-buffer-length-compatible-shape $\\color{green}104/104$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}104/104$
$\\color{green}+100.00\\%$
ndarray/base/assert/is-column-major-contiguous $\\color{green}137/137$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}137/137$
$\\color{green}+100.00\\%$
number/uint64/base/number2words $\\color{green}162/162$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}162/162$
$\\color{green}+100.00\\%$
random/base/minstd $\\color{green}627/627$
$\\color{green}+100.00\\%$
$\\color{green}68/68$
$\\color{green}+100.00\\%$
$\\color{green}12/12$
$\\color{green}+100.00\\%$
$\\color{green}627/627$
$\\color{green}+100.00\\%$
random/base/minstd-shuffle $\\color{green}752/752$
$\\color{green}+100.00\\%$
$\\color{green}78/78$
$\\color{green}+100.00\\%$
$\\color{green}14/14$
$\\color{green}+100.00\\%$
$\\color{green}752/752$
$\\color{green}+100.00\\%$
random/base/mt19937 $\\color{green}913/913$
$\\color{green}+100.00\\%$
$\\color{green}88/88$
$\\color{green}+100.00\\%$
$\\color{green}15/15$
$\\color{green}+100.00\\%$
$\\color{green}913/913$
$\\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 August 6, 2026 16:46
@kgryte
kgryte requested a review from a team August 6, 2026 16:46
@kgryte kgryte changed the title docs: propagate fixes across random/base and ndarray/base/assert chore: clean-up Aug 6, 2026
@kgryte
kgryte merged commit 58556f4 into develop Aug 6, 2026
22 checks passed
@kgryte
kgryte deleted the philipp/fix-propagation-2026-08-06 branch August 6, 2026 16:47
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Aug 6, 2026
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