Skip to content

docs: fix parameter descriptions - #16083

Merged
kgryte merged 1 commit into
developfrom
claude/cool-johnson-qzjeop
Oct 12, 2026
Merged

kgryte merged 1 commit into
developfrom
claude/cool-johnson-qzjeop

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • fixes the C API documentation of stats/base/dists/lognormal/logcdf, which called mu and sigma the "mean" and "standard deviation". For a lognormal distribution these are the location and scale parameters.

@stdlib/stats/base/dists/lognormal/logcdf

The README C APIs section, the src/main.c doc comment, and the logcdf.h header described mu and sigma as "mean" and "standard deviation", wording carried over from normal/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

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? This may include screenshots, references, and/or implementation notes.

Namespace summary. This fix came from comparing all 14 packages in stats/base/dists/lognormal, using a 75% agreement threshold.

  • Features analyzed: file tree, package.json keys, manifest.json keys, README sections, native boilerplate, public signature, validation prologue, error construction, JSDoc shape, dependencies, and C API docs.
  • Features with a clear majority (≥75%): most of them.
  • Features without one (excluded): public signature, since arity depends on the function type, and the JSDoc @returns type (number 7, NonNegativeNumber 6, Probability 1).

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:

  • logcdf has no sigma <= 0 NaN guard and documents sigma as {NonNegativeNumber}. This is intentional: sigma = 0 is a documented degenerate case, and the tests cover it.
  • stdev has no validation prologue. It inherits validation from variance.
  • ctor lacks the native addon and C APIs section. It is a JS-only class.
  • logcdf uses R fixtures instead of Julia fixtures. These are valid reference values from a different tool.
  • logcdf has no docs/img equation SVG. Adding one is not a mechanical fix.

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 helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

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

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

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/lognormal/logcdf $\\color{green}281/281$
$\\color{green}+100.00\\%$
$\\color{green}18/18$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}281/281$
$\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Oct 12, 2026
@kgryte
kgryte marked this pull request as ready for review October 12, 2026 13:36
@kgryte
kgryte requested a review from a team October 12, 2026 13:36
@kgryte kgryte changed the title docs: fix parameter descriptions in stats/base/dists/lognormal/logcdf C API docs: fix parameter descriptions Oct 12, 2026
@kgryte
kgryte merged commit 51a4592 into develop Oct 12, 2026
52 checks passed
@kgryte
kgryte deleted the claude/cool-johnson-qzjeop branch October 12, 2026 13:37
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Oct 12, 2026
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