Skip to content

fix: update parameter name#12485

Merged
kgryte merged 1 commit into
developfrom
philipp/logistic-logcdf-param-names
Jun 3, 2026
Merged

fix: update parameter name#12485
kgryte merged 1 commit into
developfrom
philipp/logistic-logcdf-param-names

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request renames the logcdf call-signature scale parameter from beta to s so it matches the documented @param s and the rest of the logistic family. Parameter names in declarations do not affect type-checking, so the docs/types/test.ts type tests are unaffected.

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:00
@stdlib-bot 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 Planeshifter changed the title fix: align parameter names with TSDoc in base/dists/logistic/logcdf chore: align parameter names with TSDoc in base/dists/logistic/logcdf Jun 3, 2026
@Planeshifter Planeshifter requested a review from kgryte June 3, 2026 05:03
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Jun 3, 2026

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/logistic/logcdf $\color{green}352/352$
$\color{green}+0.00\%$
$\color{green}31/31$
$\color{green}+0.00\%$
$\color{green}5/5$
$\color{green}+0.00\%$
$\color{green}352/352$
$\color{green}+0.00\%$

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

@Planeshifter Planeshifter marked this pull request as draft June 3, 2026 05:22
@Planeshifter Planeshifter force-pushed the philipp/logistic-logcdf-param-names branch from 6f8e2df to a8d9175 Compare June 3, 2026 05:25
@Planeshifter Planeshifter changed the title chore: align parameter names with TSDoc in base/dists/logistic/logcdf refactor: align parameter names with TSDoc in base/dists/logistic/logcdf Jun 3, 2026
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Jun 3, 2026
@kgryte kgryte marked this pull request as ready for review June 3, 2026 07:26
@kgryte kgryte changed the title refactor: align parameter names with TSDoc in base/dists/logistic/logcdf fix: update parameter name Jun 3, 2026
@kgryte kgryte merged commit 4f9ef5b into develop Jun 3, 2026
18 checks passed
@kgryte kgryte deleted the philipp/logistic-logcdf-param-names branch June 3, 2026 07:27
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants