docs: update descriptions#13511
Merged
Merged
Conversation
Corrects the misspelling `differentaial` → `differential` in `include/stdlib/stats/base/dists/levy/entropy.h`. The typo is the only occurrence of that misspelling in the `levy` namespace; every other reference to the function's description (`src/main.c`, `lib/main.js`, `lib/native.js`, `docs/repl.txt`, `docs/types/index.d.ts`, `README.md`, `test/test.js`, `test/test.native.js`, and the `ctor` package's cross references) already uses the correct spelling.
Rewrites the function-level docstring in `src/main.c` from `Returns the quantile for a Lévy distribution with location \`mu\` and scale \`c\`.` to `Evaluates the quantile function for a Lévy distribution with location parameter \`mu\` and scale parameter \`c\` at a probability \`p\`.`, matching the pattern used by all four sibling `src/main.c` docstrings in the `levy` distribution namespace (`cdf`, `pdf`, `logcdf`, `logpdf`) — 4/5 conformance before this change — and aligning `src` with the package's own header (`include/.../quantile.h`), `lib/main.js`, `lib/native.js`, `docs/repl.txt`, and `docs/types/index.d.ts`, which all already use the "Evaluates the quantile function ... at a probability \`p\`" phrasing.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jul 17, 2026
@stdlib/stats/base/dists/levy
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 docstring inconsistencies in the C implementation files of the
@stdlib/stats/base/dists/levynamespace. Both are one-line, docs-only changes; neither affects behavior, tests, examples, or type declarations.@stdlib/stats/base/dists/levy/entropyThe C header
include/stdlib/stats/base/dists/levy/entropy.hdescribes the function asdifferentaial entropy— a plain typo. It is the sole occurrence of the misspelling in the namespace; every other reference to the function (its ownsrc/main.c,lib/main.js,lib/native.js,docs/repl.txt,docs/types/index.d.ts,README.md, the two test files, and thectorpackage's cross references) spells itdifferential. Fix restores the correct spelling.@stdlib/stats/base/dists/levy/quantileThe function-level docstring in
src/main.creadReturns the quantile for a Lévy distribution with location ``mu`` and scale ``c``., dropping the "at a probabilityp" clause and theparameterqualifiers used everywhere else in the namespace. Four of five siblingsrc/main.cdocstrings understats/base/dists/levy(cdf,pdf,logcdf,logpdf— 80% conformance) follow the patternEvaluates <FUNCTION> for a Lévy distribution with location parameter ``mu`` and scale parameter ``c`` at [a] value/probability ``x``/``p``.;quantile's own header,lib/main.js,lib/native.js,docs/repl.txt, anddocs/types/index.d.tsalso use the "Evaluates the quantile function ... at a probabilityp" phrasing. Rewriting the src docstring to that form aligns it with the package's own header and the sibling C sources.Related Issues
No.
Questions
No.
Other
Total diff is 2 files, 2 lines. Neither commit touches behavior, public signatures, tests, examples, or type declarations. No auto-generated sections (
## See Also,repl.txt,.d.ts) are modified.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code on behalf of @Planeshifter as an automated cross-package API drift audit of the
@stdlib/stats/base/dists/levynamespace. Structural features (file tree,package.jsonshape, README section list, manifest shape, test/benchmark/example naming) were extracted from all 12 members. Semantic features (public signature, validation prologue, error construction, JSDoc shape, dependencies) were extracted via per-package sonnet agents fromlib/main.js,lib/index.js,lib/validate.js, andlib/factory.js. The two candidate corrections above were each independently confirmed asconfirmed-driftby three parallel reviewer agents (Opus semantic-review, Opus cross-reference, and Sonnet structural-review) before the patches were applied. A maintainer should audit and promote out of draft.