Skip to content

docs: fix example#13380

Merged
kgryte merged 2 commits into
stdlib-js:developfrom
protestershankar:fix/push-typed-array-doctest
Jul 8, 2026
Merged

docs: fix example#13380
kgryte merged 2 commits into
stdlib-js:developfrom
protestershankar:fix/push-typed-array-doctest

Conversation

@protestershankar

Copy link
Copy Markdown
Contributor

Resolves #13366.

Description

What is the purpose of this pull request?

This pull request:

  • Fixes a stdlib/jsdoc-doctest lint error in push_typed_array.js where the JSDoc @example block called push(arr, 6.0, 7.0) with individual arguments, but the private function's items parameter expects a single Array. Updated the example to push(arr, [ 6.0, 7.0 ]) to match the actual function signature and produce the correct documented output.

Related Issues

Does this pull request have any related issues?

This pull request has the following related 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

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Research and understanding

Disclosure

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

I used Claude to help understand the stdlib/jsdoc-doctest lint rule and diagnose the root cause of the mismatch (the JSDoc example passed arguments individually instead of as an array). The actual fix was a one-line change I made myself after understanding the issue.


@stdlib-js/reviewers

@protestershankar protestershankar requested a review from a team July 8, 2026 18:53
@stdlib-bot

Copy link
Copy Markdown
Contributor

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

Getting Started

Next Steps

  1. A project maintainer will approve GitHub Actions workflows for your PR.
  2. All CI checks must pass before your submission can be fully reviewed.
  3. You'll need to address any failures in linting or unit tests.

Running Tests Locally

You can use make to run any of the CI commands locally from the root directory of the stdlib repository:

# Run tests for all packages in the math namespace:
make test TESTS_FILTER=".*/@stdlib/math/.*"

# Run benchmarks for a specific package:
make benchmark BENCHMARKS_FILTER=".*/@stdlib/math/base/special/sin/.*"

If you haven't heard back from us within two weeks, please ping us by tagging the "reviewers" team in a comment on this PR.

If you have any further questions while waiting for a response, please join our Zulip community to chat with project maintainers and other community members.

We appreciate your contribution!

Documentation Links

@stdlib-bot stdlib-bot added First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Jul 8, 2026
@kgryte kgryte added difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. review: 5 and removed Needs Review A pull request which needs code review. labels Jul 8, 2026
Comment thread lib/node_modules/@stdlib/utils/push/lib/push_typed_array.js Outdated
Co-authored-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
@kgryte kgryte added review: 3 and removed review: 5 labels Jul 8, 2026
@stdlib-bot

stdlib-bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
utils/push $\\color{green}325/325$
$\\color{green}+100.00\\%$
$\\color{green}25/25$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}325/325$
$\\color{green}+100.00\\%$

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

@kgryte kgryte changed the title fix: correct push_typed_array example to pass items as array docs: fix example Jul 8, 2026
@kgryte kgryte merged commit 2fc0cf4 into stdlib-js:develop Jul 8, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. review: 3

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix JavaScript lint errors

3 participants