Repository navigation
docs: fix typo - #14277
Merged
Merged
docs: fix typo#14277
Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
…c/mgf/lib/index.js
kgryte
approved these changes
Aug 15, 2026
kgryte
marked this pull request as ready for review
August 15, 2026 04:43
stats/base/dists/geometric
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 normalizes two drifted documentation comments in the
@stdlib/stats/base/dists/geometricnamespace 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/mgfThe
lib/index.js@modulesummary 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 ownpackage.jsondescriptionand README intro. Conformance: 13/14 (93%).stats/base/dists/geometric/varianceThe
src/main.cdocblock misspelled thepparameter description as "success probablity". Corrected to "success probability", matching the sibling C implementations. The compiled routine is untouched. Conformance: 7/8 (88%).Related Issues
No related issues.
Questions
No.
Other
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 thestdevPython test fixtures were likewise left untouched as intentional. Thevariancetypo was previously noted and deferred as a spelling-defect class in #14138.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code running a scheduled cross-package API drift-detection routine over the
@stdlib/stats/base/dists/geometricnamespace. 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