Skip to content

docs: fix typo - #14277

Merged
kgryte merged 3 commits into
developfrom
claude/busy-mayer-mr0qhe
Aug 15, 2026
Merged

kgryte merged 3 commits into
developfrom
claude/busy-mayer-mr0qhe

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request normalizes two drifted documentation comments in the @stdlib/stats/base/dists/geometric namespace to the form shared by the majority of sibling packages. Both changes are documentation-only; no runtime behavior, public signature, or test expectation is affected.

stats/base/dists/geometric/mgf

The lib/index.js @module summary used an imperative form — "Evaluate the moment-generating function (MGF) for a geometric distribution." — diverging from the noun-phrase template used by every other function package in the namespace (e.g. "Geometric distribution variance."). Normalized to "Geometric distribution moment-generating function (MGF).", which already matches the package's own package.json description and README intro. Conformance: 13/14 (93%).

stats/base/dists/geometric/variance

The src/main.c docblock misspelled the p parameter description as "success probablity". Corrected to "success probability", matching the sibling C implementations. The compiled routine is untouched. Conformance: 7/8 (88%).

Related Issues

Does this pull request have any related issues?

No related issues.

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.

Both deviations were surfaced by a cross-package majority-vote drift scan of the namespace's 15 members. Features whose deviations reflect genuine mathematical differences (inclusive vs. exclusive parameter bounds; one-argument moment functions vs. two-argument point-evaluated functions) and features without a ≥75% majority were deliberately excluded; only mechanical, behavior-preserving documentation drift is included here. The constructor (ctor) and the stdev Python test fixtures were likewise left untouched as intentional. The variance typo was previously noted and deferred as a spelling-defect class in #14138.

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 a scheduled cross-package API drift-detection routine over the @stdlib/stats/base/dists/geometric namespace. The routine extracted structural and semantic features from all 15 members, computed the per-feature majority pattern (≥75% threshold), and flagged the two documentation comments deviating from the sibling-majority form. Each finding was independently verified against the sibling packages and the deviating package's own metadata before inclusion; findings requiring behavior or test changes were excluded.


@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_01H7tEqscBSpkPWzct2FAaE5


Generated by Claude Code

claude added 2 commits August 15, 2026 04:26
The `@module` description in `lib/index.js` used an imperative form
("Evaluate the moment-generating function (MGF) for a geometric
distribution.") deviating from the noun-phrase template shared by 13/14
sibling packages in the namespace (e.g. "Geometric distribution
variance."). Normalize to "Geometric distribution moment-generating
function (MGF).", matching the package's own package.json description
and README intro. Documentation only; no behavior change.
The C implementation docblock in `src/main.c` misspelled the `p`
parameter description as "success probablity". Correct to "success
probability", matching 7/8 sibling C implementations in the namespace.
Documentation only; no behavior change.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Aug 15, 2026
@stdlib-bot

stdlib-bot commented Aug 15, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/geometric/variance $\\color{green}165/165$
$\\color{green}+0.00\\%$
$\\color{green}9/9$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}165/165$
$\\color{green}+0.00\\%$

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

@kgryte
kgryte marked this pull request as ready for review August 15, 2026 04:43
@kgryte
kgryte requested a review from a team August 15, 2026 04:43
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Aug 15, 2026
@kgryte kgryte changed the title docs: correct module and parameter descriptions in stats/base/dists/geometric docs: fix typo Aug 15, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Aug 15, 2026
@kgryte
kgryte merged commit a99a888 into develop Aug 15, 2026
51 checks passed
@kgryte
kgryte deleted the claude/busy-mayer-mr0qhe branch August 15, 2026 04:59
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