Skip to content

style: remove extraneous whitespace#13654

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-07-25
Jul 26, 2026
Merged

style: remove extraneous whitespace#13654
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-07-25

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Propagating fixes merged to develop between 2026-07-24 and 2026-07-25 to sibling packages.

This propagated fix corrects a JSDoc double-space typo (p - success probability) at 17 additional sites the source commit 620be0b missed, spanning the main.js twin in binomial/quantile, eight random/iter/* package lib/main.js files, four per-package docs/types/index.d.ts files, and four lines in the aggregate random/iter/docs/types/index.d.ts. Every neighboring @param line in these files uses single spacing before the dash separator, which is the convention enforced by the stdlib/jsdoc-tag-spacing lint rule. This change brings all 17 lines into conformance with that rule.

Source: 620be0b ("chore: clean-up", #13643). Target packages:

  • @stdlib/random/iter/betaprime
  • @stdlib/random/iter/erlang
  • @stdlib/random/iter/frechet
  • @stdlib/random/iter/gamma
  • @stdlib/random/iter/invgamma
  • @stdlib/random/iter/kumaraswamy
  • @stdlib/random/iter/pareto-type1
  • @stdlib/random/iter/weibull
  • @stdlib/random/iter (namespace type declarations)
  • @stdlib/stats/base/dists/binomial/quantile

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.

Validation: candidate sites were enumerated via pattern search over all of lib/node_modules/@stdlib (@param lines with two-plus spaces before the dash, *.js and *.d.ts); each site was independently confirmed by two validation passes reading each file in full, a mechanical-applicability pass verifying exact before/after strings and single-file self-containment, and a style-consistency pass against docs/style-guides and neighboring @param lines. After this change, zero occurrences of the pattern remain repo-wide. Excluded from propagation: codebase-wide bracket-spacing style (owned by lint campaigns), new Array() lint remediations (owned by per-file lint-error issues), and auto-generated "Related Packages" sections.

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 as part of an automated fix-propagation routine: it identifies fixes recently merged to develop and applies them to sibling packages with the same defect, with each target site confirmed by independent validation passes.


@stdlib-js/reviewers


Generated by Claude Code

Propagates fix from 620be0b ("chore: clean-up") to sibling sites with
the same doc-comment typo: a double space between a parameter name and
its dash separator. Applies across `random/iter/*` and
`stats/base/dists/binomial/quantile`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011Zi8vKW1yPSGZZTbZCf3BW
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
random/iter/betaprime $\\color{green}300/300$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}300/300$
$\\color{green}+100.00\\%$
random/iter $\\color{red}5590/12615$
$\\color{green}+44.31\\%$
$\\color{green}83/83$
$\\color{green}+100.00\\%$
$\\color{red}0/41$
$\\color{green}+0.00\\%$
$\\color{red}5590/12615$
$\\color{green}+44.31\\%$
random/iter/erlang $\\color{green}301/301$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}301/301$
$\\color{green}+100.00\\%$
random/iter/frechet $\\color{green}307/307$
$\\color{green}+100.00\\%$
$\\color{green}38/38$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}307/307$
$\\color{green}+100.00\\%$
random/iter/gamma $\\color{green}300/300$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}300/300$
$\\color{green}+100.00\\%$
random/iter/invgamma $\\color{green}300/300$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}300/300$
$\\color{green}+100.00\\%$
random/iter/kumaraswamy $\\color{green}300/300$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}300/300$
$\\color{green}+100.00\\%$
random/iter/pareto-type1 $\\color{green}300/300$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}300/300$
$\\color{green}+100.00\\%$
random/iter/weibull $\\color{green}300/300$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}300/300$
$\\color{green}+100.00\\%$
stats/base/dists/binomial/quantile $\\color{red}522/524$
$\\color{green}+99.62\\%$
$\\color{red}61/62$
$\\color{green}+98.39\\%$
$\\color{green}6/6$
$\\color{green}+100.00\\%$
$\\color{red}522/524$
$\\color{green}+99.62\\%$

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

@kgryte
kgryte marked this pull request as ready for review July 26, 2026 07:23
@kgryte
kgryte requested a review from a team July 26, 2026 07:23
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 26, 2026
@kgryte kgryte changed the title chore: remove extra space in parameter descriptions style: remove extraneous whitespace Jul 26, 2026
@kgryte
kgryte merged commit 01a20c0 into develop Jul 26, 2026
35 checks passed
@kgryte
kgryte deleted the philipp/fix-propagation-2026-07-25 branch July 26, 2026 07:24
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Jul 26, 2026
@kgryte

This comment was marked as outdated.

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Jul 26, 2026
@stdlib-bot

This comment was marked as outdated.

@stdlib-bot

Copy link
Copy Markdown
Contributor

/stdlib /todo

[RFC]: add JSDoc lint rule to enforce whitespace before and after dash

Currently, we do not catch when the dash separating a parameter name from a parameter description is bordered by more than one whitespace character. We should enforce only one whitespace character on either side of the dash. So the following is good:

````js
/**
* ...
*
* @param {number} x - input value
* @returns {number} output value
*/

and the following should be disallowed

/**
*
* @param {number} x    -     input value
* @returns {number} output value
*/

In principle, we could have up to three different lint rules:

  1. enforce number of whitespace characters before dash
  2. enforce number of whitespace characters after dash
  3. enforce a specific character (e.g., -) to be used to separate a parameter name from a description

We could also have another lint rule for enforcing that a dash should not separate a @returns annotation from its description. This should likely be its own RFC.

Notes

Ref: #13654

@kgryte, slash command not recognized. Please use /stdlib help to view available commands.

@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jul 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants