Skip to content

docs: fix C API parameter descriptions - #14134

Merged
kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-lognormal-2026-08-10
Aug 10, 2026
Merged

kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-lognormal-2026-08-10

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Surfaced by an automated cross-package documentation-consistency audit of the stats/base/dists/lognormal namespace. No associated issue.

Description

What is the purpose of this pull request?

This pull request corrects the C-source (src/main.c) parameter documentation for stats/base/dists/lognormal/kurtosis, which had drifted from the namespace convention:

  • The docblock described mu as input value and sigma as minimum support — copy-paste artifacts from a bounded distribution's parameterization. Both contradict the function's own summary line ("location mu and scale sigma"), the kurtosis.h header, and the lib/main.js JSDoc. They are corrected to location parameter and scale 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

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request?

The logcdf C docblock, which documents mu/sigma as mean/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

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 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 @param pattern, flagged kurtosis as 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

…/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.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Aug 10, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/lognormal/kurtosis $\\color{green}183/183$
$\\color{green}+100.00\\%$
$\\color{green}9/9$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}183/183$
$\\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 10, 2026 12:39
@kgryte
kgryte requested a review from a team August 10, 2026 12:39
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Aug 10, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Aug 10, 2026
@kgryte kgryte changed the title docs: fix C API parameter descriptions in stats/base/dists/lognormal/kurtosis docs: fix C API parameter descriptions Aug 10, 2026
@kgryte
kgryte merged commit af0c6b6 into develop Aug 10, 2026
67 checks passed
@kgryte
kgryte deleted the philipp/drift-stats-base-dists-lognormal-2026-08-10 branch August 10, 2026 12:41
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. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants