Skip to content

refactor: correct Unary probability parameter in base/dists/bradford/quantile#12496

Draft
Planeshifter wants to merge 1 commit into
developfrom
philipp/bradford-quantile-unary-param
Draft

refactor: correct Unary probability parameter in base/dists/bradford/quantile#12496
Planeshifter wants to merge 1 commit into
developfrom
philipp/bradford-quantile-unary-param

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request corrects the quantile Unary type, whose returned function takes a probability input, not the shape parameter. Renames its parameter from c to p, fixes the @param description, and replaces the copy-pasted If c <= 0 note with the correct probability-bounds note If p < 0 or p > 1, the function returns NaN. (matching sibling quantile declarations). Renaming a parameter does not affect type-checking.

This is part of a series of follow-up PRs addressing findings from a TypeScript declaration audit of the stats namespace (documentation-only fixes landed separately in #12482).

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.

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 change was surfaced by a Claude Code audit of the stats namespace TypeScript declarations. The fix was verified against the implementation and declaration test before submission, and reviewed by myself.


@stdlib-js/reviewers

@Planeshifter Planeshifter requested a review from a team June 3, 2026 05:08
@Planeshifter Planeshifter marked this pull request as draft June 3, 2026 05:22
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Jun 3, 2026

Coverage Report

No coverage information available.

@Planeshifter Planeshifter force-pushed the philipp/bradford-quantile-unary-param branch from 441d074 to 92b4044 Compare June 3, 2026 05:26
@Planeshifter Planeshifter changed the title fix: correct Unary probability parameter in base/dists/bradford/quantile refactor: correct Unary probability parameter in base/dists/bradford/quantile Jun 3, 2026
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Jun 3, 2026
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Planeshifter The changes are off in this file.

@kgryte kgryte added the Needs Changes Pull request which needs changes before being merged. label Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Changes Pull request which needs changes before being merged. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants