docs: fix example

[Planeshifter]

Corrects two documentation/metadata inconsistencies in the stats/base/dists/degenerate namespace so that outlier packages match the conventions shared by their siblings.

Description

What is the purpose of this pull request?

This pull request normalizes summary strings and fixes a broken factory example uncovered by a cross-package consistency audit of the @stdlib/stats/base/dists/degenerate namespace (15 members). Two members deviated from namespace conventions; both corrections are mechanical, sibling-derived, and change no observable behavior.

Namespace summary

• Members analyzed: 15 — cdf, ctor, entropy, logcdf, logpdf, logpmf, mean, median, mgf, mode, pdf, pmf, quantile, stdev, variance.
• Features analyzed: file tree, package.json shape and values, manifest.json shape, README section structure, JSDoc / @module summaries, public signatures, validation prologues, error construction, and require() dependencies.
• Features with a clear majority (≥75%): package summary leading phrase — "Degenerate distribution ..." (14/15 = 93%); factory @example variable convention (7/8 factory-bearing members).
• Features without a clear majority (excluded): @param {number} mu prose (three variants, max 8/15) and per-function @returns descriptions (function-specific). Left untouched.

@stdlib/stats/base/dists/degenerate/logpmf

This package's summary string diverged from the degenerate namespace convention, under which every sibling leads with "Degenerate distribution ..."; logpmf alone read "Natural logarithm of the probability mass function (PMF) for a degenerate distribution." The package.json description and the lib/index.js @module summary are normalized to the logcdf/logpdf form ("Degenerate distribution logarithm of probability mass function (logPMF).") — 14/15 = 93% conformance. Metadata and documentation only; no functional or behavioral change.

@stdlib/stats/base/dists/degenerate/mgf

The lib/index.js @module factory @example declared the returned function as mgf via factory( 10.0 ) but then invoked an undefined identifier mymgf, which throws a ReferenceError if executed. The call is renamed to mgf so the declared and invoked identifiers match, consistent with the factory examples in 7 of 8 factory-bearing sibling packages, which invoke the same identifier they declare (for example, var pdf = factory( 10.0 ); var y = pdf( 10.0 );). Documentation only; no functional change.

Validation

Structural features were extracted from the filesystem (file trees, package.json / manifest.json shape, README sections); semantic features (signatures, validation prologues, error construction, JSDoc shape, dependencies) were extracted per package and cross-checked by independent review agents. Each candidate correction passed a three-lens drift validation covering semantic intent, cross-reference against tests and examples, and structural applicability. Deliberately excluded from correction: intentional deviations — ctor is a class constructor and legitimately lacks the C/native layer, and mean/median/mode return mu directly so they correctly omit the isnan guard that variance/stdev/entropy require; features without a ≥75% majority; and any change that would touch tests, REPL fixtures (repl.txt), or generated type declarations (*.d.ts).

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.

Both corrections are documentation/metadata only (package.json description, a lib/index.js @module summary, and a JSDoc @example); no source logic, tests, or public signatures are modified. Opened as a draft for maintainer review.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

• Read, understood, and followed the contributing guidelines.

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

This pull request was authored by Claude Code running an automated cross-package API drift-detection routine. The routine audited the stats/base/dists/degenerate namespace via majority vote, validated each candidate correction against sibling conventions, and applied the mechanical fixes. All changes were reviewed for correctness.

---

@stdlib-js/reviewers

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dists/degenerate/logpmf	$\\color{green}249/249$ $\\color{green}+0.00\\%$	$\\color{green}19/19$ $\\color{green}+0.00\\%$	$\\color{green}4/4$ $\\color{green}+0.00\\%$	$\\color{green}249/249$ $\\color{green}+0.00\\%$
stats/base/dists/degenerate/mgf	$\\color{green}253/253$ $\\color{green}+0.00\\%$	$\\color{green}14/14$ $\\color{green}+0.00\\%$	$\\color{green}4/4$ $\\color{green}+0.00\\%$	$\\color{green}253/253$ $\\color{green}+0.00\\%$

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