docs: propagate lint and example fixes to math and stats siblings#12146
Draft
Planeshifter wants to merge 2 commits into
Draft
docs: propagate lint and example fixes to math and stats siblings#12146Planeshifter wants to merge 2 commits into
math and stats siblings#12146Planeshifter wants to merge 2 commits into
Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Propagating fixes merged to
developbetween 2026-05-14 and 2026-05-15 to sibling packages exhibiting the same defect.stdlib/doctest-markerlint violationsCommit f797ee0 ("chore: fix JavaScript lint errors") replaced
// =>value markers flagged by thestdlib/doctest-markerESLint rule, which requires// returnsafter variable declarations and assignment expressions. The identical violation is present in the test files of nine siblingmath/base/specialrounding packages; left unaddressed, each fails linting the next time the file is touched. This pull request applies the same// =>→// returnscorrection:@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/floornInvalid 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 parametersigmafrom0to0.1across tenrayleighC examples, sincesigmamust be strictly positive. ThestdevandskewnessC examples were missed and still samplesigmafrom a zero lower bound. This pull request applies the same correction:@stdlib/stats/base/dists/rayleigh/stdev@stdlib/stats/base/dists/rayleigh/skewnessRelated Issues
No.
Questions
No.
Other
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/dlassqtest annotations and the oneml/incr/sgd-regressionannotation use// =>to describe a hand-computed derivation rather than a returned value, andmath/base/special/roundnfannotates a discardedfloat64intermediate —// returnswould misrepresent all eight. Thesigmacorrection 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
AI Assistance
If you answered "yes" above, how did you use AI assistance?
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