Skip to content

docs: fix options.seed duplicate and add missing options.copy tags in random/iter#11558

Merged
kgryte merged 3 commits intodevelopfrom
philipp/drift-random-iter-2026-04-18
Apr 19, 2026
Merged

docs: fix options.seed duplicate and add missing options.copy tags in random/iter#11558
kgryte merged 3 commits intodevelopfrom
philipp/drift-random-iter-2026-04-18

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

@Planeshifter Planeshifter commented Apr 18, 2026

Description

What is the purpose of this pull request?

This pull request:

  • Aligns three outlier packages in random/iter with majority JSDoc conventions observed across the 41 non-autogenerated siblings.
  • random/iter/bernoulli: removes a duplicate @param {*} [options.seed] tag (97.6% of siblings carry a single {PRNGSeedMT19937} entry).
  • random/iter/betaprime, random/iter/binomial: add the missing @param {boolean} [options.copy=true] tag between options.state and options.iter (95.1% of siblings document it; option is already implemented, tested, and documented in README/repl/TS).

No runtime, signature, or test changes.

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?

Produced by an automated cross-package drift-detection pass over random/iter (random namespace pick, seed 20260418). Three agents independently confirmed confirmed-drift for each finding. Excluded: packages with a ## References section (cite source papers); packages missing options.prng (PRNG engines/selectors); features without a ≥75% majority.

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 running a cross-package drift-detection routine.


@stdlib-js/reviewers

claude added 3 commits April 18, 2026 23:14
Remove duplicate `@param {*} [options.seed]` tag from the JSDoc; a single
`@param {PRNGSeedMT19937} [options.seed]` entry (matching 98% of siblings) is
retained.
Add missing `@param {boolean} [options.copy=true]` JSDoc tag; this option is
implemented in the source and documented in the README, repl help, and
TypeScript declarations but was missing from the main JSDoc block. Present in
95% of sibling packages.
Add missing `@param {boolean} [options.copy=true]` JSDoc tag; this option is
implemented in the source and documented in the README, repl help, and
TypeScript declarations but was missing from the main JSDoc block. Present in
95% of sibling packages.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
random/iter/bernoulli $\color{green}295/295$
$\color{green}+100.00%$
$\color{green}33/33$
$\color{green}+100.00%$
$\color{green}10/10$
$\color{green}+100.00%$
$\color{green}295/295$
$\color{green}+100.00%$
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/binomial $\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%$

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

@stdlib-js stdlib-js deleted a comment from stdlib-bot Apr 19, 2026
@Planeshifter Planeshifter changed the title docs: align outliers in random/iter with namespace majority patterns docs: fix options.seed duplicate and add missing options.copy tags in random/iter Apr 19, 2026
@Planeshifter Planeshifter marked this pull request as ready for review April 19, 2026 05:09
@Planeshifter Planeshifter requested a review from a team April 19, 2026 05:09
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 19, 2026
@Planeshifter Planeshifter requested a review from kgryte April 19, 2026 05:09
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Apr 19, 2026
@kgryte kgryte merged commit 49fc241 into develop Apr 19, 2026
69 of 70 checks passed
@kgryte kgryte deleted the philipp/drift-random-iter-2026-04-18 branch April 19, 2026 06:22
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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants