Repository navigation
docs: fix parameter descriptions - #16083
Merged
Merged
Conversation
…f` C API Replaced "mean"/"standard deviation" with "location parameter"/"scale parameter" in the C API docs of the README, `src/main.c`, and the `logcdf.h` header. This matches the package's own JavaScript docs and 12 of the 13 native packages in the namespace (92%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HSkiPsMzywnDwgruQgSSw6
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
October 12, 2026 13:36
kgryte
approved these changes
Oct 12, 2026
stats/base/dists/lognormal/logcdf C API
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
This pull request:
stats/base/dists/lognormal/logcdf, which calledmuandsigmathe "mean" and "standard deviation". For a lognormal distribution these are the location and scale parameters.@stdlib/stats/base/dists/lognormal/logcdfThe README C APIs section, the
src/main.cdoc comment, and thelogcdf.hheader describedmuandsigmaas "mean" and "standard deviation", wording carried over fromnormal/logcdf. They now say "location parameter" and "scale parameter". This matches the package's own JavaScript docs and the C docs of 12 of the 13 native packages in the namespace (92%). The change is to comments and docs only.Related Issues
No.
Questions
No.
Other
Namespace summary. This fix came from comparing all 14 packages in
stats/base/dists/lognormal, using a 75% agreement threshold.package.jsonkeys,manifest.jsonkeys, README sections, native boilerplate, public signature, validation prologue, error construction, JSDoc shape, dependencies, and C API docs.@returnstype (number7,NonNegativeNumber6,Probability1).Validation. Each package's features were extracted from its files, plus a per-package read of the source. Each outlier was then reviewed by three agents (semantic, cross-reference, structural). These deviations were reviewed and left as they are:
logcdfhas nosigma <= 0NaN guard and documentssigmaas{NonNegativeNumber}. This is intentional:sigma = 0is a documented degenerate case, and the tests cover it.stdevhas no validation prologue. It inherits validation fromvariance.ctorlacks the native addon and C APIs section. It is a JS-only class.logcdfuses R fixtures instead of Julia fixtures. These are valid reference values from a different tool.logcdfhas nodocs/imgequation SVG. Adding one is not a mechanical fix.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code, as part of an automated check that compares sibling packages for inconsistencies.
@stdlib-js/reviewers
🤖 Generated with Claude Code
https://claude.ai/code/session_01HSkiPsMzywnDwgruQgSSw6
Generated by Claude Code