docs: describe mu as location parameter in stats/base/dists/logistic/mgf#12874
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: describe mu as location parameter in stats/base/dists/logistic/mgf#12874Planeshifter wants to merge 1 commit into
mu as location parameter in stats/base/dists/logistic/mgf#12874Planeshifter wants to merge 1 commit into
Conversation
…ic/mgf` The JSDoc summary and `mu` `@param` description in `lib/main.js`, `lib/factory.js`, and `lib/native.js`, plus the matching block comments in `src/main.c` and `include/stdlib/stats/base/dists/logistic/mgf.h`, referred to `mu` as "mean". The 13 sibling packages under `stats/base/dists/logistic/` describe `mu` as the "location parameter" (13/14 = 93% conformance among the native-binding members), and the mgf package's own README, TypeScript declarations, and REPL documentation already use "location parameter". Normalize the remaining lib/ and src/ doc comments to match.
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 the JSDoc
mudescription instats/base/dists/logistic/mgfto match the namespace-wide convention used by the other 13 native-binding packages:"location parameter"instead of"mean".Namespace summary
cdf,ctor,entropy,kurtosis,logcdf,logpdf,mean,median,mgf,mode,pdf,quantile,skewness,stdev,variance).lib/factory.js(a 6-of-15 semantic split between factory-producing kernels and direct-arithmetic ones).Per outlier package
stats/base/dists/logistic/mgf@param {number} muand the surrounding JSDoc summary referred tomuas"mean"inlib/main.js,lib/factory.js, andlib/native.js, and the matching block comments insrc/main.candinclude/stdlib/stats/base/dists/logistic/mgf.hcarried the same wording. The 13 sibling packages understats/base/dists/logistic/describemuas the"location parameter"(13/14 = 93% conformance among the native-binding members), and the samemgfpackage'sREADME.md,docs/types/index.d.ts, anddocs/repl.txtalready use"location parameter"— only thelib/andsrc/doc comments lagged. Sibling location-familymgfpackages (laplace/mgf,gumbel/mgf) follow the same convention;normal/mgfis the one legitimate"mean"user, because for the normal distributionmuIS canonically the mean, which is not the case for the logistic family.Related Issues
No.
Questions
No.
Other
Validation
package.jsonshape, README headings, manifest shape, test/benchmark/example file naming).mgfcandidate; all three returnedconfirmed-drift.Deliberately excluded from this PR:
ctoris the canonical "missing native-binding artifacts" outlier in this namespace (nobinding.gyp,src/, Julia fixtures, etc.) — intentional, sincectoris a JS-only distribution-class constructor.stdevuses Python rather than Julia test fixtures (test/fixtures/python/vs the 13-of-14 majoritytest/fixtures/julia/). Markedneeds-human: the test file imports the Python fixture, so migrating would require regenerating fixtures and rewriting the test — out of scope for a drift-correction PR.mean/median/modeusevar <pkg> = require( './main.js' )rather than the 12-of-15 majorityvar main = .... The named-variable form is the ecosystem-wide convention across ≥27 sibling distributions, so this is not local drift.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of the namespace drift-detection routine. A randomly selected namespace (
stats/base/dists/logistic) was feature-extracted across all 15 members; majority patterns were computed at 75% conformance; outliers were gated through a three-agent validation pass before any patch was applied. A human maintainer should verify the patch before promoting this PR out of draft.@stdlib-js/reviewers
Generated by Claude Code