Skip to content

docs: add missing usage notes sections and MGF link - #14392

Merged
kgryte merged 3 commits into
developfrom
philipp/drift-stats-base-dists-beta-2026-08-18
Aug 19, 2026
Merged

docs: add missing usage notes sections and MGF link#14392
kgryte merged 3 commits into
developfrom
philipp/drift-stats-base-dists-beta-2026-08-18

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request normalizes three README documentation inconsistencies in the stats/base/dists/beta namespace against the conventions used by the majority of sibling packages. All changes are documentation-only and render no observable output difference.

Namespace summary

  • Members analyzed: 15 (cdf, ctor, entropy, kurtosis, logcdf, logpdf, mean, median, mgf, mode, pdf, quantile, skewness, stdev, variance); 0 autogenerated.
  • Features analyzed: structural (file tree, package.json key/script sets, README section structure and blockquote-link convention, manifest.json shape, test/benchmark/example naming) and semantic (public signature, return kind, validation prologue in lib/main.js and lib/factory.js, error construction, JSDoc shape, dependencies).
  • Features with a clear majority (≥75%): core file set and package.json key set (15/15); validation prologues (consistent by arity — grouped isnan checks for three-argument functions, interleaved for two-argument properties); JSDoc @param/@returns/@example shape; JavaScript-side <section class="notes"> placeholder (12/15); blockquote metric-term reference link (11/14 applicable).
  • Features without a clear majority (excluded): the Notes content section (2/15, logcdf/logpdf); secondary test/test.<name>.js naming; the native-binding split (gypfile, C API files — 11/15, excluded as incremental per-package work); language-specific benchmark and fixture files (SciPy/Julia).

cdf

The JavaScript-side usage documentation ran straight from the usage section into the examples section, omitting the empty <section class="notes"> placeholder carried by 12 of 15 (80%) packages in the namespace. This package's own C API section already contains the placeholder, so the JavaScript-side omission is template drift, not intent. Added the placeholder; it renders nothing.

quantile

Same omission — no notes section on the JavaScript side against the 80% namespace majority. Added the empty <section class="notes"> placeholder to match. Documentation output is unchanged.

mgf

The introductory blockquote left "moment-generating function" as plain text while the README body links [moment-generating function][mgf] four times and defines the [mgf] reference. Wrapped the blockquote term in the existing reference link, matching both the in-file usage and the 11 of 14 (79%) applicable siblings that link the metric term in the blockquote.

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.

Validation

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 pull request was authored by Claude Code as an automated cross-package drift-detection run over the stats/base/dists/beta namespace. Candidate corrections were extracted programmatically from structural and semantic feature comparisons, independently validated by parallel reviewer agents (semantic, cross-reference, and structural review), and confined to documentation. A maintainer should audit and promote out of draft.


@stdlib-js/reviewers


Generated by Claude Code

claude added 3 commits August 18, 2026 20:28
Insert the empty `<section class="notes">` placeholder on the JavaScript
side of the README, between the usage and examples sections. The
placeholder is present in 12 of 15 (80%) sibling packages in the
namespace and is already present in this package's own C API section;
its absence on the JavaScript side was an inconsistency with the
namespace template. The section renders no content, so documentation
output is unchanged.
Insert the empty `<section class="notes">` placeholder on the JavaScript
side of the README, between the usage and examples sections. The
placeholder is present in 12 of 15 (80%) sibling packages in the
namespace; its absence here was an inconsistency with the namespace
template. The section renders no content, so documentation output is
unchanged.
Wrap "moment-generating function" in the introductory blockquote with
the `[moment-generating function][mgf]` reference link. The `[mgf]`
reference is already defined in this README and used four times in the
body, so only the blockquote diverged; 11 of 14 (79%) applicable sibling
packages link the metric term in the blockquote. Link markup only; the
rendered text is unchanged.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Aug 18, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/beta/cdf $\\color{green}337/337$
$\\color{green}+100.00\\%$
$\\color{green}29/29$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}337/337$
$\\color{green}+100.00\\%$
stats/base/dists/beta/mgf $\\color{green}409/409$
$\\color{green}+100.00\\%$
$\\color{green}24/24$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}409/409$
$\\color{green}+100.00\\%$
stats/base/dists/beta/quantile $\\color{green}234/234$
$\\color{green}+100.00\\%$
$\\color{green}23/23$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}234/234$
$\\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 August 19, 2026 00:24
@Planeshifter
Planeshifter requested review from a team and kgryte August 19, 2026 00:24
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Aug 19, 2026
@kgryte kgryte changed the title docs: add missing usage notes sections and MGF blockquote link in stats/base/dists/beta docs: add missing usage notes sections and MGF link Aug 19, 2026
@kgryte
kgryte merged commit 4df94c4 into develop Aug 19, 2026
51 checks passed
@kgryte
kgryte deleted the philipp/drift-stats-base-dists-beta-2026-08-18 branch August 19, 2026 07:08
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Aug 19, 2026
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