Repository navigation
docs: fix descriptions - #13938
Merged
kgryte merged 2 commits intoAug 5, 2026
Merged
docs: fix descriptions#13938
Conversation
The native.js JSDoc lead description was copied from the uniform
distribution package and described a "uniform distribution with
minimum support `a` and maximum support `b`"; replace it with the
Kumaraswamy wording used by the package's own main.js and by all 11
C-backed sibling native.js files in the namespace (100% conformance
among peers). Also add a missing space in the package.json
description ("(CDF)for" -> "(CDF) for"), matching the well-formed
descriptions of the other 12 namespace members.
The C header doc comment described the log-PDF as the "probability distribution function (CDF)"; correct it to "probability density function (PDF)", matching the package's own main.js, README JS-API section, and src/main.c, and consistent with the sibling logcdf.h naming its own function. Also fix the same "probability distribution function" -> "probability density function" wording in the README C API section, aligning it with the JS-API description above it.
kgryte
marked this pull request as ready for review
August 5, 2026 08:30
kgryte
approved these changes
Aug 5, 2026
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
stats/base/dists/kumaraswamy
kgryte
deleted the
philipp/drift-stats-base-dists-kumaraswamy-2026-08-05
branch
August 5, 2026 08:39
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 corrects copy-paste documentation errors in two members of
@stdlib/stats/base/dists/kumaraswamythat described the wrong distribution or the wrong function type. No behavior, signatures, or test expectations change; the edits are documentation-only and bring the two outliers in line with wording already used by their own source files and their sibling packages.The namespace was analyzed for cross-package documentation drift. Every member except these two was already consistent; the corrections below are the only deviations that are both unambiguous errors and mechanically fixable without touching public behavior.
Namespace summary
cdf,ctor,kurtosis,logcdf,logpdf,mean,median,mode,pdf,quantile,skewness,stdev,variance).package.json/manifest.json/directoriesshape, README section structure,lib/layout, public signatures, error construction, validation prologues, JSDoc/Doxygen shape, andrequiredependency sets.ctorconstructor class, measure functions (cdf/logcdf/logpdf/pdf/quantile) versus moment functions, and C-implemented versus JS-only packages.pdfandctorlegitimately differ) and presence oflib/factory.js(measure-function-only). These are not treated as drift.logcdfThe native-addon JSDoc description was carried over verbatim from the uniform distribution package, describing a distribution with
minimum supportandmaximum supportrather than the two Kumaraswamy shape parameters. It now matches the package's ownmain.jsand all eleven C-backed siblingnative.jsfiles in the namespace (100% conformance among peers). Thepackage.jsondescription also dropped the space in(CDF)for; it is restored to match the other twelve members.logpdfBoth the C header doc comment and the README C-API summary labeled the log-density as a
probability distribution function, with the header additionally tagging it(CDF). Both are corrected toprobability density function (PDF), matchingmain.js,src/main.c, and the package's own JS-API description, and consistent withlogcdf.hnaming its own function.Related Issues
None.
Questions
No.
Other
Validation. Corrections were derived from a structural extraction (filesystem and string features across all 13 members), a semantic extraction (public signatures, error construction, validation, JSDoc/Doxygen shape, dependencies), and an adversarial drift-validation pass. Only errors that are unambiguous, mechanical, and behavior-preserving advanced.
Deliberately excluded from this PR:
pdflacking a C implementation (present in 11/13 members). Adding a native addon is authored C math, not a mechanical fix, and a maintainer-reviewed attempt (feat: add C implementation forstats/base/dists/kumaraswamy/pdf#10067) was previously closed unmerged.kurtosisandskewnesslackingtest/fixtures/julia/(present for five of seven moment functions). Generating reference data requires a Julia runtime and would rewrite the test assertions from a type check to a tolerance comparison; both files carry an explicit// TODO: Add fixturesmarker. Out of scope.ctorconstructor shape, measure-vs-moment signatures).Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was prepared by Claude Code running an automated cross-package documentation-drift analysis over the
stats/base/dists/kumaraswamynamespace. AI extracted structural and semantic features from every member, identified the majority documentation wording per feature, flagged deviating packages, and applied the four documentation corrections above. Each edit was verified against the package's own source files and its sibling packages before committing. A human should review before this draft is marked ready.@stdlib-js/reviewers
Generated by Claude Code