Repository navigation
docs: fix C API parameter descriptions - #14134
Merged
kgryte merged 1 commit intoAug 10, 2026
Merged
Conversation
…/kurtosis`
The C source docblock documented `mu` as "input value" and `sigma` as
"minimum support", which are copy-paste artifacts from an unrelated
distribution's parameterization. Both contradict the function's own
summary line ("location `mu` and scale `sigma`"), the `kurtosis.h`
header, and the JavaScript `lib/main.js` JSDoc, all of which describe
`mu` and `sigma` as the location and scale parameters.
Corrected the two `@param` descriptions to "location parameter" and
"scale parameter", matching 11/13 addon-bearing sibling packages in the
namespace (85%). Comment-only change; no behavior or test impact.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
August 10, 2026 12:39
kgryte
approved these changes
Aug 10, 2026
stats/base/dists/lognormal/kurtosis
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.
Surfaced by an automated cross-package documentation-consistency audit of the
stats/base/dists/lognormalnamespace. No associated issue.Description
This pull request corrects the C-source (
src/main.c) parameter documentation forstats/base/dists/lognormal/kurtosis, which had drifted from the namespace convention:muasinput valueandsigmaasminimum support— copy-paste artifacts from a bounded distribution's parameterization. Both contradict the function's own summary line ("locationmuand scalesigma"), thekurtosis.hheader, and thelib/main.jsJSDoc. They are corrected tolocation parameterandscale parameter, matching 11/13 (85%) of the addon-bearing sibling packages in the namespace. The change is comment-only: no behavior, signatures, or test expectations are affected.Related Issues
None.
Questions
No.
Other
The
logcdfC docblock, which documentsmu/sigmaasmean/standard deviation, was deliberately left untouched: those descriptions are mathematically accurate for the underlying normal and self-consistent between the header and source, so they are an authorial choice rather than drift.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code running an automated cross-package documentation-drift audit. The audit extracted structural and semantic features across all 14 packages in the namespace, identified the majority C-docblock
@parampattern, flaggedkurtosisas the sole outlier, and independently verified (with a second agent) that the deviation is an unintentional copy-paste rather than a genuine semantic difference before applying the correction. Please review before merge.@stdlib-js/reviewers
Generated by Claude Code