Repository navigation
docs: clean-up - #14454
Merged
kgryte merged 1 commit intoAug 21, 2026
Merged
docs: clean-up#14454
Conversation
Corrects two JSDoc-only inconsistencies in `stats/base/dists/logistic/logcdf`
identified by a majority-vote sweep against the 14 sibling packages in the
`stats/base/dists/logistic` namespace:
- `lib/index.js`: drop the redundant second `var y` in the `@module`
`@example` block. `y` is already declared four lines above, and all
five sibling factory-bearing packages (`cdf`, `pdf`, `logpdf`, `mgf`,
`quantile`) reuse the identifier on the second call (5/5 conformance
among factory-bearing siblings).
- `docs/types/index.d.ts`: change the `Unary` type's
`@returns evaluated logarithm of CDF` to `@returns evaluated logCDF`,
matching the wording already used at lines 43 and 92 of the same file
and the `evaluated <ABBREV>` convention used by every sibling
type-def (5/5 sibling type-defs).
No runtime, signature, or test-expected behavior changes.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
August 20, 2026 23:59
kgryte
approved these changes
Aug 20, 2026
stats/base/dists/logistic/logcdf
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 two JSDoc-only inconsistencies in
stats/base/dists/logistic/logcdfsurfaced by a majority-vote drift sweep against the 14 sibling packages in thestats/base/dists/logisticnamespace.stats/base/dists/logistic/logcdflib/index.js: drop the redundant secondvar yin the@module@example.yis already declared four lines above; all five sibling factory-bearing packages (cdf,pdf,logpdf,mgf,quantile) reuse the identifier on the second call (5/5 conformance among factory-bearing siblings).docs/types/index.d.ts: change theUnarytype's@returns evaluated logarithm of CDFto@returns evaluated logCDF, matching the wording already used at lines 43 and 92 of the same file and theevaluated <ABBREV>convention shared by every sibling type-def (5/5 sibling type-defs). Conformance in the namespace as a whole: 14/15.No runtime, signature, test-expected, or public-API behavior changes; both edits sit inside JSDoc comment blocks.
Related Issues
No.
Questions
No.
Other
Opened as a draft for maintainer review.
Deliberately excluded from this run:
logcdf/LICENSE— flagged as a stray file (unique across the 15 siblings), but rejected on second review: the file documents third-party attribution forlogcdf/lib/log1pexp.js, which is adapted from StatsFuns.jl (Copyright © 2015 Dahua Lin, MIT). Per-packageLICENSEfiles ship across ~184 stdlib packages under this convention; the other 14logisticsiblings simply have no third-party derivation to attribute.ctor— legitimately lacks C/native/manifest/factory (it is the distribution class, structurally distinct from the moment and function packages).s <= 0.0vs function-package prologues usings < 0.0— mathematically driven (whether the function is defined ats = 0), not drift.stdev/variance@returns {PositiveNumber}— correct; both are strictly positive.stdevshipping Python test fixtures instead of Julia — converting would cascade into rewriting test data andtest.js, which the drift routine excludes as out of scope.entropy.h,mean.h,test.pdf.js, per-package equation SVGs) — normal per-package variation.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was produced by an automated Claude Code routine that picks a random stdlib namespace, extracts structural and semantic features from every package in it, identifies the majority pattern per feature, and drafts corrections for packages that deviate without semantic justification. Every candidate correction was passed through three independent validation agents (semantic review, cross-reference, structural review); items marked
intentional-deviationorneeds-humanby any agent were dropped and are listed in the "Other" section above. Opened as a draft for maintainer review.@stdlib-js/reviewers
Generated by Claude Code