Repository navigation
docs: fix default period in simulate/iter/periodic-sinc JSDoc - #15961
Draft
Planeshifter wants to merge 1 commit into
Draft
Planeshifter wants to merge 1 commit into
Planeshifter wants to merge 1 commit into
Conversation
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
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request:
options.periodin the@stdlib/simulate/iter/periodic-sincJSDoc from10to100, matching the implementation, README, REPL text, and TypeScript declarations.simulate/iter/periodic-sincThe
lib/main.jsJSDoc declared[options.period=10], while the implementation initializesopts.periodto100and every other documentation surface states100. Insimulate/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
No.
Questions
No.
Other
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, andawunlacklib/validate.js;awgn,awln,awun, andperiodic-sinctake positional arguments ahead ofoptions) 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 ordern.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
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