Skip to content

docs: correct C API heading function name in stats/base/dists/exponential/logcdf#11996

Merged
kgryte merged 1 commit intodevelopfrom
claude/inspiring-curie-nnuaQ
May 8, 2026
Merged

docs: correct C API heading function name in stats/base/dists/exponential/logcdf#11996
kgryte merged 1 commit intodevelopfrom
claude/inspiring-curie-nnuaQ

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Corrects a copy-paste typo in the ## C APIs section of lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/README.md. The #### heading on line 166 documented stdlib_base_dists_exponential_cdf( x, lambda ) — the cdf sibling's function name — instead of the actual function stdlib_base_dists_exponential_logcdf( x, lambda ). The same file's subsequent code blocks (lines 171, 181, 222), the public header (include/stdlib/stats/base/dists/exponential/logcdf.h), src/main.c, and src/addon.c all use the correct name.

stats/base/dists/exponential/logcdf

Sole drift item: C API heading text drifted from the function it documents (13/14 = 93% of sibling packages with a C API section name the heading to match the implemented function). One-line fix; no code, tests, or examples touched.

Related Issues

None.

Questions

No.

Other

Cross-package drift scan over the 15 members of @stdlib/stats/base/dists/exponential/. Structural extraction (file trees, package.json shape, README headings, manifest.json shape) and semantic extraction (signatures, validation prologues, error construction, JSDoc shape, dependencies) found one feature with a clear majority and a single outlier:

  • C API #### heading text matches function name: 13/14 packages with a C API section conform; logcdf was the lone outlier.

Other inter-package differences (PositiveNumber vs NonNegativeNumber parameter typing, presence of factory(), presence of native bindings) reflect genuine semantic groupings (scalar-valued vs bivariate functions; ctor is a JS-only constructor) and were excluded from the drift list. Validation: structural review confirmed the heading-name pattern, and a cross-reference check confirmed no test or example references stdlib_base_dists_exponential_cdf from within the logcdf package.

Checklist

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

This PR was authored by Claude Code as part of a cross-package API drift detection routine. The routine extracted structural and semantic features from all 15 packages in @stdlib/stats/base/dists/exponential/, computed per-feature majority patterns, and flagged a single outlier — a copy-paste error in the logcdf README's C API heading. Validation confirmed the deviation was unintentional (every other reference in the same file already uses the correct function name) and the fix is mechanical (one-word heading correction, no behavior change).



Generated by Claude Code

…ntial/logcdf`

The C API heading in `logcdf/README.md` documented `stdlib_base_dists_exponential_cdf`,
copy-pasted from the sibling `cdf` package, instead of the actual function name
`stdlib_base_dists_exponential_logcdf` (already used correctly in the same file's code
blocks at lines 171, 181, 222 and in `src/main.c`, `src/addon.c`, and the public
header).

Conformance: 13/14 sibling packages in `stats/base/dists/exponential/` (93%) name
their C API heading to match the implemented function. `logcdf` was the lone outlier.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label May 8, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/exponential/logcdf $\color{green}279/279$
$\color{green}+100.00%$
$\color{green}20/20$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}279/279$
$\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 May 8, 2026 04:49
@Planeshifter Planeshifter requested review from a team and kgryte May 8, 2026 04:49
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 8, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 8, 2026
@kgryte kgryte merged commit ff7716f into develop May 8, 2026
71 checks passed
@kgryte kgryte deleted the claude/inspiring-curie-nnuaQ branch May 8, 2026 05:10
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