Skip to content

docs: propagate lint and example fixes to math and stats siblings#12146

Merged
kgryte merged 2 commits into
developfrom
claude/wonderful-planck-f9HrR
May 17, 2026
Merged

docs: propagate lint and example fixes to math and stats siblings#12146
kgryte merged 2 commits into
developfrom
claude/wonderful-planck-f9HrR

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Propagating fixes merged to develop between 2026-05-14 and 2026-05-15 to sibling packages exhibiting the same defect.

stdlib/doctest-marker lint violations

Commit f797ee0 ("chore: fix JavaScript lint errors") replaced // => value markers flagged by the stdlib/doctest-marker ESLint rule, which requires // returns after variable declarations and assignment expressions. The identical violation is present in the test files of nine sibling math/base/special rounding packages; left unaddressed, each fails linting the next time the file is touched. This pull request applies the same // =>// returns correction:

  • @stdlib/math/base/special/ceiln
  • @stdlib/math/base/special/roundn
  • @stdlib/math/base/special/cceiln
  • @stdlib/math/base/special/floornf
  • @stdlib/math/base/special/roundb
  • @stdlib/math/base/special/floorb
  • @stdlib/math/base/special/cfloorn
  • @stdlib/math/base/special/croundn
  • @stdlib/math/base/special/floorn

Invalid scale parameter in Rayleigh C examples

Commit b517ce1 ("docs: propagate description and example fixes in stats/base/dists/*") raised the lower sampling bound of the Rayleigh scale parameter sigma from 0 to 0.1 across ten rayleigh C examples, since sigma must be strictly positive. The stdev and skewness C examples were missed and still sample sigma from a zero lower bound. This pull request applies the same correction:

  • @stdlib/stats/base/dists/rayleigh/stdev
  • @stdlib/stats/base/dists/rayleigh/skewness

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?

Each candidate site was located by searching for the source pattern's structural signature within the originating namespace, then validated by two independent reviews of each target file in full, an adaptation pass confirming the fix applies verbatim, and a style-consistency pass.

Sites where a textual match did not correspond to the same defect were deliberately excluded: the six lapack/base/dlassq test annotations and the one ml/incr/sgd-regression annotation use // => to describe a hand-computed derivation rather than a returned value, and math/base/special/roundnf annotates a discarded float64 intermediate — // returns would misrepresent all eight. The sigma correction was scoped to the Rayleigh scale parameter only; strictly-positive parameters in other distributions were left untouched, as confirming their domain constraints requires per-distribution review beyond the scope of this propagation.

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

This pull request was authored by Claude Code as part of an automated routine that propagates recently merged fixes to sibling packages sharing the same defect. Every propagation site was independently validated before inclusion; nothing was applied on a textual match alone.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits May 15, 2026 13:30
Propagates fix from f797ee0 ("chore: fix JavaScript lint errors") to
sibling math/base/special rounding packages whose test files contain
the same stdlib/doctest-marker violation, replacing `// =>` value
markers with `// returns`.
Propagates fix from b517ce1 ("docs: propagate description and example
fixes in stats/base/dists/*") to the rayleigh stdev and skewness C
examples, which still sampled the scale parameter sigma from a zero
lower bound.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
math/base/special/cceiln $\color{green}188/188$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}188/188$
$\color{green}+100.00%$
math/base/special/ceiln $\color{green}272/272$
$\color{green}+100.00%$
$\color{green}24/24$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}272/272$
$\color{green}+100.00%$
math/base/special/cfloorn $\color{green}179/179$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}179/179$
$\color{green}+100.00%$
math/base/special/croundn $\color{green}176/176$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}176/176$
$\color{green}+100.00%$
math/base/special/floorb $\color{green}203/203$
$\color{green}+100.00%$
$\color{green}24/24$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}203/203$
$\color{green}+100.00%$
math/base/special/floorn $\color{green}272/272$
$\color{green}+100.00%$
$\color{green}24/24$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}272/272$
$\color{green}+100.00%$
math/base/special/floornf $\color{red}274/276$
$\color{green}+99.28%$
$\color{red}22/23$
$\color{green}+95.65%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{red}274/276$
$\color{green}+99.28%$
math/base/special/roundb $\color{green}203/203$
$\color{green}+100.00%$
$\color{green}24/24$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}203/203$
$\color{green}+100.00%$
math/base/special/roundn $\color{green}279/279$
$\color{green}+100.00%$
$\color{green}23/23$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}279/279$
$\color{green}+100.00%$
stats/base/dists/rayleigh/skewness $\color{green}169/169$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}169/169$
$\color{green}+100.00%$
stats/base/dists/rayleigh/stdev $\color{green}169/169$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}169/169$
$\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 17, 2026 21:22
@kgryte kgryte requested a review from a team May 17, 2026 21:22
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 17, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 17, 2026
@kgryte kgryte merged commit 906bab9 into develop May 17, 2026
55 checks passed
@kgryte kgryte deleted the claude/wonderful-planck-f9HrR branch May 17, 2026 21:23
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