docs: normalize stats/base/dists/degenerate/logpmf description to sibling convention#13365
Closed
Planeshifter wants to merge 1 commit into
Closed
docs: normalize stats/base/dists/degenerate/logpmf description to sibling convention#13365Planeshifter wants to merge 1 commit into
stats/base/dists/degenerate/logpmf description to sibling convention#13365Planeshifter wants to merge 1 commit into
Conversation
…ibling convention Align the `package.json` description, README blurb, and `lib/index.js` `@module` docstring with the noun-phrase convention used by the other 13 non-`ctor` packages in `stats/base/dists/degenerate` (93% conformance). Direct log-analogs (`logcdf`, `logpdf`) both use the "Degenerate distribution logarithm of ..." shape; `logpmf` was the sole outlier using the imperative "Evaluate the natural logarithm of ..." form. Also add the missing `"logpmf"` self-keyword to the `package.json` `keywords` array; 13/14 sibling packages include their own function name as a keyword (both `logcdf` and `logpdf` carry their `log*` keyword), `logpmf` was the only package missing it. No behavior change; documentation and metadata only.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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
stats/base/dists/degenerate/logpmfdocumentation and metadata to the noun-phrase convention used by every other package in the namespace.Namespace summary
stats/base/dists/degenerate(cdf,ctor,entropy,logcdf,logpdf,logpmf,mean,median,mgf,mode,pdf,pmf,quantile,stdev,variance).ctorexcluded from the doc-shape vote (it is a class constructor, not a numeric routine, and legitimately lacks the C native infrastructure the rest of the namespace shares).package.jsondescription form (13/14),README.mdshort-blurb form (13/14),lib/index.js@moduledocstring form (13/14), self-name-as-keyword (13/14).docs/repl.txtacronym convention across the threelog*variants (mixed —logcdfuses(logCDF)in some places and(CDF)in others),"discrete"vs"continuous"keyword tagging, presence ofdocs/img/equation_*.svgequation renders.stats/base/dists/degenerate/logpmfFour related drift items, one outlier package:
package.jsondescriptionwas the sole imperative-form string ("Natural logarithm of the probability mass function (PMF) for a degenerate distribution."); 13/14 sibling packages, including the direct analogslogcdfandlogpdf, use the noun-phrase shape"Degenerate distribution <thing>.". Normalized to"Degenerate distribution logarithm of probability mass function (logPMF)."to matchlogpdfverbatim.README.mdshort blurb followed the same imperative shape (13/14 sibling conformance) and used the wrong acronym(PMF)wherelogpdf's blurb uses(logPDF). Rewritten to match.lib/index.js@moduledocstring on line 22 had the same imperative form; 13/14 sibling@moduledocstrings useDegenerate distribution ...noun-phrase.package.jsonkeywordswas missing"logpmf"; 13/14 sibling packages include their own function name as a keyword, and bothlogcdfandlogpdfinclude theirlog*keyword next to the plaincdf/pdfentry.Validation
package.jsonshape, README section list,manifest.json,test/benchmark/examplesfilename sets).ctorpackages via inline inspection oflib/main.js,lib/index.js,docs/repl.txt, anddocs/types/index.d.ts.logpmfcorrection against sibling conventions: no test files, benchmarks, or downstream consumers read the drifted strings; noDo not manually editmarker guards any of the four edited locations; both direct analogs (logcdf,logpdf) confirm the target form.ctorpackage's absence of C-native infrastructure (structural but justified — it is a JS class),main.jsJSDoc acronym form for the threelog*variants (only two other samples with mixed conventions between them), keyword ordering of"ln"/"natural"(cosmetic).Related Issues
This pull request has the following related issues:
Questions
No.
Other
Diff is 4 lines across 3 files, no behavior change.
docs:label is used per the commit message guide — the priority order putsdocsabovechorewhen a change mixes README/JSDoc updates withpackage.jsonmetadata.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
Drafted by Claude Code as part of an automated cross-package drift-detection routine that extracts structural and semantic features from every package in a randomly-picked namespace, identifies the majority pattern per feature (≥75% threshold), and proposes fixes to outliers. All four corrections here were reviewed against direct sibling analogs before applying.
@stdlib-js/reviewers
Generated by Claude Code