Skip to content

docs: refactor example to use array PRNG (issue #8227) #8233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Oct 30, 2025
Merged

docs: refactor example to use array PRNG (issue #8227) #8233

merged 3 commits into from
Oct 30, 2025

Conversation

@Udit19199
Copy link
Contributor

@Udit19199 Udit19199 commented Oct 13, 2025 •
edited by kgryte
Loading

Description

What is the purpose of this pull request?

Updates the example for someByRight to use @stdlib/random/array/randu for creating the example array.

This change addresses a no-new-array linting error and improves the example's conciseness by replacing a for loop with a direct function call, as recommended by project maintainers.

The refactoring has been applied to both the runnable example (examples/index.js) and the example included in the package README.md. A no-redeclare directive has been added to the README.md to resolve a linter error caused by multiple example blocks declaring the same variable name.

Related Issues

Does this pull request have any related issues?

This pull request:

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.

  • Read, understood, and followed the [contributing guidelines][contributing].

@Udit19199
fix(utils/some-by-right): refactor example to use array PRNG
38b75c1 
Updates the example for `someByRight` to use
`@stdlib/random/array/randu` for creating the example array.

This change addresses a `no-new-array` linting error and improves the
example's conciseness by replacing a `for` loop with a direct
function call.

The refactoring has been applied to both the runnable example
(`examples/index.js`) and the example included in the package
`README.md`. A `no-redeclare` directive has been added to the
`README.md` to resolve a linter error caused by multiple example
blocks declaring the same variable name.

---
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: passed
  - 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 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. labels Oct 13, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Oct 13, 2025

👋 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 Gitter channel to chat with project maintainers and other community members.

We appreciate your contribution!

Documentation Links

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Oct 13, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
utils/some-by-right $\color{green}135/135$
$\color{green}+100.00\%$ 		$\color{green}15/15$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}135/135$
$\color{green}+100.00\%$

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

@Udit19199 Udit19199 changed the title fix(utils/some-by-right): refactor example to use array PRNG fix(utils/some-by-right): refactor example to use array PRNG (issue #8227) Oct 13, 2025
@kgryte kgryte changed the title fix(utils/some-by-right): refactor example to use array PRNG (issue #8227) docs: refactor example to use array PRNG (issue #8227) Oct 30, 2025
kgryte
kgryte reviewed Oct 30, 2025
View reviewed changes
@kgryte kgryte mentioned this pull request Oct 30, 2025
Closed
1 task
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Oct 30, 2025
@kgryte kgryte merged commit 67a57a2 into stdlib-js:develop Oct 30, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

First-time Contributor A pull request from a contributor who has never previously committed to the project repository.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix JavaScript lint errors

3 participants

@Udit19199 @stdlib-bot @kgryte