docs: add missing README C documentation to stats/base/dists/pareto-type1#11941
Open
Planeshifter wants to merge 1 commit intodevelopfrom
Open
docs: add missing README C documentation to stats/base/dists/pareto-type1#11941Planeshifter wants to merge 1 commit intodevelopfrom
stats/base/dists/pareto-type1#11941Planeshifter wants to merge 1 commit intodevelopfrom
Conversation
… conventions Adds the missing `## C APIs` section (present in 79% of siblings, universal among siblings shipping native code). The package already ships `binding.gyp`, `lib/native.js`, `src/`, `include/` and `manifest.json`; this patch only documents the existing C entry point to bring the README in line with `cdf`, `logcdf`, `logpdf`, `quantile`, and the moment-function packages.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
stats/base/dists/pareto-type1 with namespace conventionsstats/base/dists/pareto-type1
stats/base/dists/pareto-type1stats/base/dists/pareto-type1
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
Aligning outliers in
stats/base/dists/pareto-type1with namespace majority patterns (random namespace pick, seed20260505).Namespace summary
cdf,ctor,entropy,kurtosis,logcdf,logpdf,mean,median,mode,pdf,quantile,skewness,stdev,variance); 0 excluded as autogenerated.package.jsonshape, README sections (set + sequence),manifest.jsonshape,test//benchmark//examples/file naming, public signature, return kind, validation prologue, error construction, JSDoc shape, dependency set.package.jsontop-level keys (85.7%), README L2/L3 section set (78.6%),test/files (85.7%),benchmark/files (85.7%),examples/files (85.7%), JSDochasExample(100%),returnKind(100% for non-ctor).package.jsonscriptskeys (0 universal),package.jsonstdlibkeys (0 universal), README section sequence (most common at 64.3%),validationPrologue(mixed across sonnet extractions; underlying behavior is uniform NaN-return),errorConstruction(13/14plain-stringreflects "no error built" rather than a target style — nothing to normalize towardformat).Per-outlier corrections
stats/base/dists/pareto-type1/pdfAdds the missing
## C APIssection to the README forstats/base/dists/pareto-type1/pdf, which ships a full native implementation (binding.gyp,src/main.c,src/addon.c, etc.) but lacked documentation for its C entry point. Within thestats/base/dists/pareto-type1/namespace, 11 of 14 sibling packages carry this section (79%), and every sibling with native artifacts includes it —pdfwas the lone exception. The section is adapted from thecdftemplate, updated with the correct function name, signature, and a worked example (stdlib_base_dists_pareto_type1_pdf( 4.0, 1.0, 1.0 ) => ~0.063).Validation
lib/main.js/lib/index.js/lib/factory.js/lib/native.jsand returned a fixed-schema JSON bundle; all 14 returned valid JSON on first attempt.ctoroutlier flags (no native artifacts, distinct constructor JSDoc shape,format-style errors, optional defaults) — intentional deviation: distribution constructors are pure-JS wrappers across stdlib by design.medianoutlier flags (no native artifacts) — confirmed structural drift but the corresponding fix is a full native port (C source, manifest, Julia fixtures,test.native.js); not mechanical, out of scope for the routine. Logged for future work.logcdf/logpdfREADME sequence drift (extraNotessection) — package-specific narrative content, not drift.Related Issues
No.
Questions
No.
Other
This PR is the output of the cross-package API drift detection routine, run on a uniformly-randomly-sampled eligible namespace (seed
20260505,total_eligible = 121). The full machine-readable report (member list, per-feature majority pattern, conformance percentages, all dropped-correction rationales) is archived alongside the run.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was generated by an automated cross-package drift-detection routine driven by Claude Code. Per-package source extraction was delegated to Sonnet agents, drift validation was performed by three independent Opus/Sonnet agents (semantic-review, cross-reference, structural-review), and the resulting README patch on
stats/base/dists/pareto-type1/pdfwas authored by Claude. A human will audit and promote this draft before merge.@stdlib-js/reviewers
Generated by Claude Code