Skip to content

docs: fix scale parameter reference in @stdlib/stats/base/dists/levy/entropy#12258

Merged
kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-levy-2026-05-24
May 24, 2026
Merged

docs: fix scale parameter reference in @stdlib/stats/base/dists/levy/entropy#12258
kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-levy-2026-05-24

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • corrects the JSDoc description in @stdlib/stats/base/dists/levy/entropy to reference the scale parameter as c, matching the function signature and the convention used by the other 10 of 11 sibling packages under @stdlib/stats/base/dists/levy/* (91% conformance).

entropy

The description in lib/main.js and docs/types/index.d.ts referenced the scale parameter as s, but the function signature names it c. The s is a copy-paste artifact from sibling distributions whose scale parameter is genuinely named s (e.g., logistic, frechet). Two-line fix; no behavior, signature, or test change.

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? This may include screenshots, references, and/or implementation notes.

The same typo is propagated into the parent aggregator lib/node_modules/@stdlib/stats/base/dists/levy/docs/types/index.d.ts (line 73). That file is outside this PR's scope (sibling-package drift only); leaving as a separate follow-up.

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 via an automated cross-package drift-detection routine: structural and semantic features were extracted across the 12 child packages of @stdlib/stats/base/dists/levy/, the majority pattern per feature was identified, and entropy's JSDoc description was flagged as the lone deviator (1 of 11) on the scale-parameter reference. The fix was applied mechanically and validated against sibling source.



Generated by Claude Code

…/entropy`

Update the description in `lib/main.js` and `docs/types/index.d.ts` to
reference the scale parameter as `c`, matching the function signature
and the convention used by sibling packages in
`@stdlib/stats/base/dists/levy/*` (10/11 = 91%). The `s` appears to be
a copy-paste artifact from sibling distributions (e.g., logistic,
frechet) whose scale parameter is named `s`.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label May 24, 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%$

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

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label May 24, 2026
@kgryte kgryte marked this pull request as ready for review May 24, 2026 09:23
@kgryte kgryte requested a review from a team May 24, 2026 09:23
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 24, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label May 24, 2026
@kgryte kgryte merged commit 47f803e into develop May 24, 2026
70 checks passed
@kgryte kgryte deleted the philipp/drift-stats-base-dists-levy-2026-05-24 branch May 24, 2026 09:24
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