docs: add missing usage notes sections and MGF link - #14392
Merged
Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Aug 19, 2026
stats/base/dists/beta
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 three README documentation inconsistencies in the
stats/base/dists/betanamespace against the conventions used by the majority of sibling packages. All changes are documentation-only and render no observable output difference.Namespace summary
cdf, ctor, entropy, kurtosis, logcdf, logpdf, mean, median, mgf, mode, pdf, quantile, skewness, stdev, variance); 0 autogenerated.package.jsonkey/script sets, README section structure and blockquote-link convention,manifest.jsonshape, test/benchmark/example naming) and semantic (public signature, return kind, validation prologue inlib/main.jsandlib/factory.js, error construction, JSDoc shape, dependencies).package.jsonkey set (15/15); validation prologues (consistent by arity — groupedisnanchecks for three-argument functions, interleaved for two-argument properties); JSDoc@param/@returns/@exampleshape; JavaScript-side<section class="notes">placeholder (12/15); blockquote metric-term reference link (11/14 applicable).Notescontent section (2/15,logcdf/logpdf); secondarytest/test.<name>.jsnaming; the native-binding split (gypfile, C API files — 11/15, excluded as incremental per-package work); language-specific benchmark and fixture files (SciPy/Julia).cdfThe 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.quantileSame 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.mgfThe 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
No.
Questions
No.
Other
Validation
lib/main.js,lib/factory.js,lib/index.js, JSDoc, and READMEs) were run across all 15 members.confirmed-driftfor the three corrections in this PR. No test or example depends on the edited README content.beta/pdfandbeta/logpdfblockquote-link fixes (already proposed in open PR chore: propagate recentdevelopfixes to sibling packages (2026-07-10) #13410); thebeta/pdfnotes-section placeholder (real drift, but excluded to avoid editingpdf/README.mdconcurrently with chore: propagate recentdevelopfixes to sibling packages (2026-07-10) #13410);beta/logcdf(open PR feat: add C implementation forstats/base/dists/beta/logcdf#13649 in flight; not an outlier here regardless); native-binding and language-specific fixture differences (incremental / ecosystem-level, not drift); and all features lacking a clear ≥75% majority.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This pull request was authored by Claude Code as an automated cross-package drift-detection run over the
stats/base/dists/betanamespace. 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