Skip to content

Conversation

@kaushal-kumar-it
Copy link
Contributor


type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes. report:

  • task: lint_filenames status: passed
  • task: lint_editorconfig status: passed
  • task: lint_markdown status: passed
  • task: lint_package_json status: na
  • task: lint_repl_help status: na
  • task: lint_javascript_src status: na
  • task: lint_javascript_cli status: na
  • task: lint_javascript_examples status: na
  • task: lint_javascript_tests status: na
  • task: lint_javascript_benchmarks status: na
  • task: lint_python status: na
  • task: lint_r status: na
  • task: lint_c_src status: na
  • task: lint_c_examples status: na
  • task: lint_c_benchmarks status: na
  • task: lint_c_tests_fixtures status: na
  • task: lint_shell status: na
  • task: lint_typescript_declarations status: passed
  • task: lint_typescript_tests status: na
  • task: lint_license_headers status: passed ---

Description

What is the purpose of this pull request?

This pull request adds a cosine wave visualization to the
@stdlib/simulate/iter/cosine-wave documentation. The figure illustrates the
shape of a cosine waveform over multiple periods and helps readers better
understand how the iterator generates values over time.

This update improves the usability and clarity of the package documentation by
providing a visual reference alongside the mathematical description.

Related Issues

Does this pull request have any related issues?

This pull request is not associated with any existing issues.

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

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure
indicating how you used AI assistance.

Not applicable.


@stdlib-js/reviewers

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 7, 2026
@stdlib-bot
Copy link
Contributor

Coverage Report

Package Statements Branches Functions Lines
simulate/iter/cosine-wave $\color{green}300/300$
$\color{green}+100.00%$
$\color{green}32/32$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}300/300$
$\color{green}+100.00%$

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

Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kaushal-kumar-it Thanks for looking to resolve the TODO. My general comment is that, rather than static figures, we'd leverage stdlib's plot functionality to generate plots as part of an automated build process similar to what we do for SVG equations. Unfortunately, the plot API is currently being refactored and is under construction. Hence, my initial inclination is that we'd should put this PR on hold until the upstream changes have been completed and we can autogenerate as part of a workflow.

@kgryte kgryte changed the title feat: add cosine wave visualization to simulate/iter/cosine-wave docs: add cosine wave visualization to simulate/iter/cosine-wave Jan 7, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. Needs Discussion Needs further discussion. and removed Needs Review A pull request which needs code review. labels Jan 7, 2026
@kaushal-kumar-it
Copy link
Contributor Author

Thanks @kgryte for the clarification. That approach makes sense. I’m fine with putting this PR on hold until the plot API refactor is complete and we can generate plots via an automated workflow.

@kaushal-kumar-it kaushal-kumar-it marked this pull request as draft January 8, 2026 06:48
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. Needs Discussion Needs further discussion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants