docs: fix typos and copy-paste errors in `stats` TypeScript declarations by Planeshifter · Pull Request #12482 · stdlib-js/stdlib

Planeshifter · 2026-06-03T04:43:35Z

Description

What is the purpose of this pull request?

This pull request fixes documentation-only issues in hand-written TypeScript declaration files (docs/types/index.d.ts) across the stats namespace, surfaced by a systematic audit of the namespace's .d.ts files. All changes are confined to comments (TSDoc summaries, @param/@returns/@throws text, @example blocks, and ## Notes prose); no function signatures, types, or exports were modified.

Highlights:

Fix typos and garbled prose (e.g. b = < 0 → b < 0, "an maximum support" → "and maximum support", "along roes" → "along rows").
Correct copy-paste errors where a summary/@example referenced the wrong distribution or operation (e.g. gumbel/logistic mgf summaries naming the "Gamma distribution", kumaraswamy logpdf naming the "Arcsine distribution", padjust documenting holm as "Hommel's method").
Align @param names and descriptions with their signatures (e.g. mgf @param x → @param t; negative-binomial statistic @param r "failures" → "successes"; binomial/arcsine quantile probability args).
Fix @example issues (paired ttest example now passes y; var y redeclarations changed to reassignment; corrected // returns annotations such as ~-1.938 → ~-1.941).
Normalize wording/formatting drift across sibling families (e.g. "natural logarithm", mgf block-comment terminator alignment, Unicode λ/σ → lambda/sigma in Notes).

Note: this PR intentionally edits only the underlying package declaration files; the generated namespace-root aggregator docs/types/index.d.ts files are not hand-edited and will regenerate from these sources. Findings that require actual declaration changes (parameter renames in signatures, type fixes, a logpdf→logpmf method rename, a missing dcorrelation export, etc.) are intentionally excluded and will be submitted as separate per-package PRs.

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.

No.

Checklist

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

Read, understood, and followed the contributing guidelines.

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 prepared with Claude Code: an agent audited the stats namespace TypeScript declarations, and per-file agents applied the verified documentation-only fixes. Each finding was independently verified against the source file before editing. The changes were reviewed by myself prior to submission.

@stdlib-js/reviewers

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---

stdlib-bot · 2026-06-03T05:48:06Z

Coverage Report

No coverage information available.

kgryte · 2026-06-03T06:08:19Z

@@ -31,15 +31,15 @@ type Unary = ( x: number ) => number;
 */
 interface LogPDF {
 	/**
-	* Evaluates the natural logarithm of the probability density function (PDF) for an inverse gamma distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
+	* Evaluates the natural logarithm of the probability density function (PDF) for an inverse gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`.


@Planeshifter I'm confused. In invgamma/cdf above, you changed scale to rate, and now in this package for invgamma/logpdf you are changing rate to scale. Which is it?

According to Wikipedia, this should be scale. There are several other packages in invgamma which also need updating.

E.g., https://github.com/stdlib-js/stdlib/tree/29784543332ee5b7d10e378a9fd6f714f0839b87/lib/node_modules/%40stdlib/stats/base/dists/invgamma/mean

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

…ocs/types/index.d.ts

…cs/types/index.d.ts

…yc/docs/types/index.d.ts

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

kgryte

LGTM after a fair amount of clean-up.

kgryte · 2026-06-03T07:11:50Z

As the CI failure is expected, I'll go ahead and merge.

Planeshifter requested a review from a team June 3, 2026 04:43

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Jun 3, 2026

Planeshifter force-pushed the philipp/stats-ts-docs-fixes branch from 284f244 to bd917b9 Compare June 3, 2026 04:49

kgryte removed the Needs Review A pull request which needs code review. label Jun 3, 2026

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/dists/invgamma/quantile/docs/types/index.d.ts

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/factory/docs/types/index.d.ts Outdated

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/factory/docs/types/index.d.ts Outdated

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/incr/mgrubbs/docs/types/index.d.ts Outdated

Apply suggestions from code review

ebea002

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/incr/mgrubbs/docs/types/index.d.ts Outdated

kgryte added 4 commits June 2, 2026 23:16

Apply suggestions from code review

5db02f5

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

Discard changes to lib/node_modules/@stdlib/stats/strided/dnanrange/d…

035a450

…ocs/types/index.d.ts

Discard changes to lib/node_modules/@stdlib/stats/strided/dstdevyc/do…

a375280

…cs/types/index.d.ts

Discard changes to lib/node_modules/@stdlib/stats/strided/nanvariance…

54a5c1c

…yc/docs/types/index.d.ts

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/midrange-by/docs/types/index.d.ts

Apply suggestions from code review

524d9cc

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts Outdated

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts Outdated

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts Outdated

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts Outdated

kgryte reviewed Jun 3, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts Outdated

Apply suggestions from code review

77237b1

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>

kgryte approved these changes Jun 3, 2026

View reviewed changes

kgryte added the Documentation Improvements, additions, or changes to documentation. label Jun 3, 2026

kgryte merged commit f59b324 into develop Jun 3, 2026
28 of 29 checks passed

kgryte deleted the philipp/stats-ts-docs-fixes branch June 3, 2026 07:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: fix typos and copy-paste errors in `stats` TypeScript declarations#12482

docs: fix typos and copy-paste errors in `stats` TypeScript declarations#12482
kgryte merged 8 commits into
developfrom
philipp/stats-ts-docs-fixes

Planeshifter commented Jun 3, 2026

Uh oh!

stdlib-bot commented Jun 3, 2026

Uh oh!

kgryte Jun 3, 2026

Uh oh!

kgryte Jun 3, 2026

Uh oh!

kgryte Jun 3, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kgryte left a comment

Uh oh!

kgryte commented Jun 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Planeshifter commented Jun 3, 2026

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

stdlib-bot commented Jun 3, 2026

Coverage Report

Uh oh!

kgryte Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

kgryte Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

kgryte Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

kgryte commented Jun 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants