Skip to content

docs: update descriptions#13511

Merged
kgryte merged 2 commits into
developfrom
philipp/drift-stats-base-dists-levy-2026-07-17
Jul 17, 2026
Merged

docs: update descriptions#13511
kgryte merged 2 commits into
developfrom
philipp/drift-stats-base-dists-levy-2026-07-17

Conversation

@Planeshifter

@Planeshifter Planeshifter commented Jul 17, 2026

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request corrects two docstring inconsistencies in the C implementation files of the @stdlib/stats/base/dists/levy namespace. Both are one-line, docs-only changes; neither affects behavior, tests, examples, or type declarations.

@stdlib/stats/base/dists/levy/entropy

The C header include/stdlib/stats/base/dists/levy/entropy.h describes the function as differentaial entropy — a plain typo. It is the sole occurrence of the misspelling in the namespace; every other reference to the function (its own src/main.c, lib/main.js, lib/native.js, docs/repl.txt, docs/types/index.d.ts, README.md, the two test files, and the ctor package's cross references) spells it differential. Fix restores the correct spelling.

@stdlib/stats/base/dists/levy/quantile

The function-level docstring in src/main.c read Returns the quantile for a Lévy distribution with location `` mu`` and scale ``c ``., dropping the "at a probability p" clause and the parameter qualifiers used everywhere else in the namespace. Four of five sibling src/main.c docstrings under stats/base/dists/levy (cdf, pdf, logcdf, logpdf — 80% conformance) follow the pattern Evaluates <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, and docs/types/index.d.ts also use the "Evaluates the quantile function ... at a probability p" phrasing. Rewriting the src docstring to that form aligns it with the package's own header and the sibling C sources.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request?

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

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

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/levy namespace. Structural features (file tree, package.json shape, 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 from lib/main.js, lib/index.js, lib/validate.js, and lib/factory.js. The two candidate corrections above were each independently confirmed as confirmed-drift by 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.


claude added 2 commits July 17, 2026 00:20
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.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Jul 17, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/levy/entropy $\\color{green}184/184$
$\\color{green}+100.00\\%$
$\\color{green}9/9$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}184/184$
$\\color{green}+100.00\\%$
stats/base/dists/levy/quantile $\\color{green}295/295$
$\\color{green}+100.00\\%$
$\\color{green}23/23$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}295/295$
$\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

@kgryte
kgryte marked this pull request as ready for review July 17, 2026 02:59
@kgryte
kgryte requested a review from a team July 17, 2026 02:59
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 17, 2026
@kgryte kgryte changed the title docs: correct docstrings under @stdlib/stats/base/dists/levy docs: update descriptions Jul 17, 2026
@kgryte
kgryte merged commit 5447bd7 into develop Jul 17, 2026
56 checks passed
@kgryte
kgryte deleted the philipp/drift-stats-base-dists-levy-2026-07-17 branch July 17, 2026 03:02
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants