Skip to content

docs: fix parameter names - #15928

Merged
kgryte merged 2 commits into
developfrom
claude/cool-johnson-g06hv6
Oct 12, 2026
Merged

kgryte merged 2 commits into
developfrom
claude/cool-johnson-g06hv6

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • renames the @param a / @param b tags in the C implementations of stats/base/dists/f/mode and stats/base/dists/f/skewness to d1 / d2, matching the function signatures and 7 of 9 (78%) native siblings in stats/base/dists/f.

stats/base/dists/f/mode

src/main.c documents @param a and @param b, but the signature is stdlib_base_dists_f_mode( const double d1, const double d2 ). Renamed the tags to d1 and d2 and realigned @return, matching 78% of native siblings and the package's own README C API section.

stats/base/dists/f/skewness

Same drift as mode: src/main.c documents a and b against a d1, d2 signature. Renamed the tags and realigned @return (78% conformance). Comment-only change. No behavior change.

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

Namespace summary. stats/base/dists/f has 11 members and none are autogenerated, so the majority threshold is ⌈11 × 0.75⌉ = 9 packages (for C-only features, 7 of the 9 native packages). Features analyzed: file tree, package.json keys, manifest.json shape and dependencies, README headings, native boilerplate (binding.gyp, include.gypi, Makefiles, addon.c), JS and C validation prologues, and JS and C doc tags. Clear majorities: file tree, package.json keys, README headings, manifest.json keys and JS doc tags. No clear majority: the C validation prologue (4/9 check is_nan explicitly, 5/9 do not) and the JS prologue order (grouped vs. interleaved NaN checks).

Validation. Excluded on purpose:

  • cdf has no native implementation, which is not a mechanical fix. feat: add C implementation for stats/base/dists/f/cdf #14692 already proposes it.
  • ctor has a different API shape, which is intentional.
  • quantile has C++ fixtures in place of Julia fixtures, which is intentional.
  • pdf uses no eps in its C benchmark and example, because it generates inputs differently.
  • Copyright-year differences in the native boilerplate.
  • entropy returns {number} instead of {PositiveNumber}. Entropy can be negative.

The changed lines are doc comments only. Tests, examples and generated artifacts are untouched.

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 cross-package drift-detection run.


@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_01WPC1t4Bd9JXeZ7HAuFDETK


Generated by Claude Code

claude added 2 commits October 6, 2026 00:36
Renamed `@param a` and `@param b` to `@param d1` and `@param d2` to match the function signature, and realigned the `@return` column accordingly. `d1`/`d2` parameter documentation is used in 7 of 9 (78%) native sibling packages in `stats/base/dists/f`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WPC1t4Bd9JXeZ7HAuFDETK
…tation

Renamed `@param a` and `@param b` to `@param d1` and `@param d2` to match the function signature, and realigned the `@return` column accordingly. `d1`/`d2` parameter documentation is used in 7 of 9 (78%) native sibling packages in `stats/base/dists/f`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WPC1t4Bd9JXeZ7HAuFDETK
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Oct 6, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/f/mode $\\color{green}195/195$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}195/195$
$\\color{green}+100.00\\%$
stats/base/dists/f/skewness $\\color{green}207/207$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}207/207$
$\\color{green}+100.00\\%$

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

@Planeshifter
Planeshifter marked this pull request as ready for review October 6, 2026 15:44
@Planeshifter
Planeshifter requested a review from a team October 6, 2026 15:44
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Oct 6, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Oct 12, 2026
@kgryte kgryte changed the title docs: fix C parameter names in stats/base/dists/f/mode and stats/base/dists/f/skewness docs: fix parameter names Oct 12, 2026
@kgryte
kgryte merged commit d06f1b1 into develop Oct 12, 2026
67 checks passed
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