docs: add cosine wave visualization to simulate/iter/cosine-wave#9599
docs: add cosine wave visualization to simulate/iter/cosine-wave#9599kaushal-kumar-it wants to merge 1 commit intostdlib-js:developfrom
simulate/iter/cosine-wave#9599Conversation
---
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
---
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
left a comment
There was a problem hiding this comment.
@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.
simulate/iter/cosine-wavesimulate/iter/cosine-wave
|
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. |
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes. report:
Description
This pull request adds a cosine wave visualization to the
@stdlib/simulate/iter/cosine-wavedocumentation. The figure illustrates theshape 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
This pull request is not associated with any existing issues.
Questions
No.
Other
No.
Checklist
AI Assistance
Disclosure
Not applicable.
@stdlib-js/reviewers