Skip to content

docs: fix default period in simulate/iter/periodic-sinc JSDoc - #15961

Draft
Planeshifter wants to merge 1 commit into
developfrom
claude/cool-johnson-xfkysh
Draft

Planeshifter wants to merge 1 commit into
developfrom
claude/cool-johnson-xfkysh

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • corrects the documented default for options.period in the @stdlib/simulate/iter/periodic-sinc JSDoc from 10 to 100, matching the implementation, README, REPL text, and TypeScript declarations.

simulate/iter/periodic-sinc

The lib/main.js JSDoc declared [options.period=10], while the implementation initializes opts.period to 100 and every other documentation surface states 100. In simulate/iter, JSDoc option defaults agree with implementation defaults in 15 of 16 packages (94%), and this package was the sole outlier. Documentation-only change, with no change in behavior.

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.

Found via a cross-package drift check over simulate/iter (16 packages), which compared each package's structure and API conventions against its siblings. Other outliers (awgn, awln, and awun lack lib/validate.js; awgn, awln, awun, and periodic-sinc take positional arguments ahead of options) were reviewed and left as is because they reflect real API differences: the noise packages transform an input iterator and use PRNG options, and the periodic sinc function requires an order n.

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written primarily by Claude Code as part of an automated cross-package drift check.


@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_015VrPVVu7ie6zNGcbmV7eoP


Generated by Claude Code

The JSDoc for `options.period` documented a default of `10`, while the
implementation, README, REPL text, and TypeScript declarations all use
`100`.

-   Corrected `[options.period=10]` to `[options.period=100]` (JSDoc option defaults match implementation defaults in 94% of `simulate/iter` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015VrPVVu7ie6zNGcbmV7eoP
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
simulate/iter/periodic-sinc $\\color{green}381/381$
$\\color{green}+100.00\\%$
$\\color{green}53/53$
$\\color{green}+100.00\\%$
$\\color{green}6/6$
$\\color{green}+100.00\\%$
$\\color{green}381/381$
$\\color{green}+100.00\\%$

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

This branch has not been deployed

No deployments
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.

3 participants