Skip to content

docs: propagate recent develop fixes to sibling packages#12400

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

docs: propagate recent develop fixes to sibling packages#12400
kgryte merged 3 commits into
developfrom
philipp/fix-propagation-2026-05-31

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Propagating fixes merged to develop between b9dbd3e3 (2026-05-30 15:16 -0500) and 15f6a2c0d (2026-05-31 07:04 -0500) to sibling packages with the same underlying defect.

Pattern: explicit float literal in continuous-parameter guards in stats/base/dists/t/* factories

faef34302 changed beta <= 0 to beta <= 0.0 in stats/base/dists/gumbel/cdf/lib/factory.js to enforce the explicit-float-literal convention for continuous-parameter guard checks. The same bare-integer comparison guards the degrees-of-freedom parameter v in t/pdf and t/logpdf; sibling t-distribution files (t/cdf, t/logcdf, t/quantile) already use 0.0, so this aligns the remaining two.

Pattern: add missing <stdint.h> includes to C usage examples in READMEs

2bab6a4b added #include <stdint.h> to two C usage-example code blocks in blas/ext/base/dmskrev/README.md that declared uint8_t mask[] without the header that defines the type. The same defect — a ```c usage-example code block referencing int8_t/`int32_t`/`int64_t` without including `<stdint.h>` — appears in 13 other usage-example blocks across `math/base/napi/quaternary`, `stats/base/dists/binomial/mgf`, and seven `ndarray/base/*` packages plus `ndarray/ctor`. Each insertion is placed in the existing include block in sorted position (between project `"..."` headers and `<stdlib.h>`/`<stdio.h>`), matching the placement convention already used in sibling blocks of the same file.

  • 2bab6a4b (docs: fix missing header)
    • @stdlib/math/base/napi/quaternary (two blocks)
    • @stdlib/stats/base/dists/binomial/mgf
    • @stdlib/ndarray/base/flatten-shape-from
    • @stdlib/ndarray/base/flatten-shape
    • @stdlib/ndarray/base/function-object (three blocks)
    • @stdlib/ndarray/base/minmax-view-buffer-index
    • @stdlib/ndarray/base/nonsingleton-dimensions
    • @stdlib/ndarray/base/shape2strides
    • @stdlib/ndarray/base/singleton-dimensions
    • @stdlib/ndarray/ctor

Related Issues

None.

Questions

No.

Other

Validation

Reviewed the 18 fix-class commits (fix/docs/chore/test/style/perf) merged to develop in the 24-hour window. Two propagatable source patterns advanced to the patch stage; per-pattern search scope and validation procedure:

  • Search scope: scoped to the source commit's namespace first (stats/base/dists/*/lib/factory.js for the float-literal style, README C-code blocks under blas/, lapack/, math/, stats/, ndarray/, random/ for the missing-include pattern), and exhaustive within those scopes.
  • Two independent opus validation passes confirmed (a) the defect is present at each candidate site, (b) surrounding context does not change the semantics, and (c) the proposed patch matches the source commit's exact fix shape.
  • A style-consistency pass adjusted include placement for blocks that already contained other headers, ensuring <stdint.h> lands in sorted position rather than at the block top.

Deliberately excluded:

  • Two function-signature-only ```c blocks (ndarray/base/function-object/README.md lines 230-232 and 360-362) and the `ndarrayFunctionObject` struct definition block (lines 110-136): the source commit's pattern targets runnable usage examples, not API signatures or type definitions.
  • Six usage-example blocks that already include <inttypes.h> (ndarray/base/{flatten-shape-from,flatten-shape,minmax-view-buffer-index,nonsingleton-dimensions,shape2strides,singleton-dimensions}/README.md examples sections): POSIX guarantees <inttypes.h> transitively includes <stdint.h>, so there is no compile-time defect and the addition would be purely cosmetic.
  • The misspelled "auxilary" keyword fix from b9dbd3e3 ("chore: remove misspelled keyword"): exhaustive grep confirmed no remaining occurrences in the repository after the source commit.
  • The missing-main()-JSDoc fix from 7719ac8d ("docs: fix missing function description"): exhaustive scan of all 2002 benchmark files under @stdlib/blas confirmed no remaining sites missing the JSDoc block.
  • Per-distribution one-off error-message wording corrections from 003cb6ec and 4f28e691 (array/float16/lib/polyfill/index.js): single-package wording changes with no sibling-package signature.
  • Autogenerated namespace TOC, related-packages, and TypeScript-declaration cleanup commits (78f0c534, 9d352486, 1c951503, fe7c2746, 313aca0c): generator-owned files or already-broad cleanup waves not amenable to mechanical propagation.

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 on behalf of @Planeshifter as an automated propagation of fixes merged to develop over the prior 24 hours. Candidate source commits were filtered for generalizable patterns, sibling sites located via grep-able pattern signatures, and each proposed patch independently validated by parallel reviewer agents (two opus validation passes plus a sonnet style-consistency pass) before commits were applied in the primary worktree. A human will audit and promote the PR out of draft.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits May 31, 2026 13:24
Propagates fix from faef343 ("style: use explicit float literal in
`stats/base/dists/gumbel/cdf`") to sibling Student's t distribution
factory functions, applying the convention of using `0.0` rather than
bare `0` when comparing continuous-valued parameters.
Propagates fix from 2bab6a4 ("docs: fix missing header") to sibling
package READMEs whose ```c usage examples reference stdint fixed-width
integer types (`int8_t`, `int32_t`, `int64_t`) without the corresponding
`<stdint.h>` header. Limited to runnable usage examples; function
signature blocks and reference-only type definitions are excluded.
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented May 31, 2026

Coverage Report

Package Statements Branches Functions Lines
math/base/napi/quaternary $\color{green}156/156$
$\color{green}+0.00\%$
$\color{green}5/5$
$\color{green}+0.00\%$
$\color{green}1/1$
$\color{green}+0.00\%$
$\color{green}156/156$
$\color{green}+0.00\%$
ndarray/base/flatten-shape-from $\color{green}225/225$
$\color{green}+0.00\%$
$\color{green}13/13$
$\color{green}+0.00\%$
$\color{green}2/2$
$\color{green}+0.00\%$
$\color{green}225/225$
$\color{green}+0.00\%$
ndarray/base/flatten-shape $\color{green}190/190$
$\color{green}+0.00\%$
$\color{green}9/9$
$\color{green}+0.00\%$
$\color{green}2/2$
$\color{green}+0.00\%$
$\color{green}190/190$
$\color{green}+0.00\%$
ndarray/base/minmax-view-buffer-index $\color{green}282/282$
$\color{green}+0.00\%$
$\color{green}18/18$
$\color{green}+0.00\%$
$\color{green}2/2$
$\color{green}+0.00\%$
$\color{green}282/282$
$\color{green}+0.00\%$
ndarray/base/nonsingleton-dimensions $\color{green}111/111$
$\color{green}+0.00\%$
$\color{green}5/5$
$\color{green}+0.00\%$
$\color{green}1/1$
$\color{green}+0.00\%$
$\color{green}111/111$
$\color{green}+0.00\%$
ndarray/base/singleton-dimensions $\color{green}111/111$
$\color{green}+0.00\%$
$\color{green}5/5$
$\color{green}+0.00\%$
$\color{green}1/1$
$\color{green}+0.00\%$
$\color{green}111/111$
$\color{green}+0.00\%$
stats/base/dists/t/logpdf $\color{green}273/273$
$\color{green}+0.00\%$
$\color{green}17/17$
$\color{green}+0.00\%$
$\color{green}4/4$
$\color{green}+0.00\%$
$\color{green}273/273$
$\color{green}+0.00\%$
stats/base/dists/t/pdf $\color{green}275/275$
$\color{green}+0.00\%$
$\color{green}17/17$
$\color{green}+0.00\%$
$\color{green}4/4$
$\color{green}+0.00\%$
$\color{green}275/275$
$\color{green}+0.00\%$

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

…clude

Reverts the `<stdint.h>` additions from the previous commit for code
blocks whose project headers already pull in `<stdint.h>` transitively
(`ndarray/{ctor,base/shape2strides,base/function-object}` via their
respective public headers; `stats/base/dists/binomial/mgf` via
`mgf.h`). Those additions were stylistic rather than corrective, and
the larger of them (`ndarray/ctor`, `ndarray/base/shape2strides`)
inflated the affected-tests dependency set to ~2k packages, surfacing
pre-existing test failures unrelated to this propagation.

Retained sites are usage examples whose blocks include no header that
transitively defines stdint types — matching the source commit's
exact pattern.
@kgryte kgryte marked this pull request as ready for review May 31, 2026 20:56
@kgryte kgryte requested a review from a team May 31, 2026 20:56
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 31, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 31, 2026
@kgryte kgryte changed the title docs: propagate recent develop fixes to sibling packages (2026-05-31) docs: propagate recent develop fixes to sibling packages May 31, 2026
@kgryte kgryte merged commit 510d710 into develop May 31, 2026
50 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-05-31 branch May 31, 2026 20:57
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