Skip to content
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.

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

docs: improve examples of random/strided/tools namespace #2693

Closed
wants to merge 1 commit into from

Conversation

kohantikanath
Copy link
Contributor

Resolves #1610

Description

What is the purpose of this pull request?

This pull request:

  • Improves the README examples for the random/strided/tools namespace package

  • Provides a more comprehensive and informative example demonstrating various functionalities of the package

  • Enhances user understanding of how to use the namespace contents

Related Issues

Does this pull request have any related issues?
This pull request:

Questions

Any questions for reviewers of this pull request?

  • The updated example covers creating PRNG factories, filling different types of arrays, and demonstrating stride manipulation. Are there any other key functionalities that should be included?
  • Is the level of detail in the example appropriate, or should it be expanded/condensed?

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

  • The example uses ES5 syntax as per project conventions
  • Additional packages from the stdlib ecosystem were used to create a more informative example

Checklist

Please ensure the following tasks are completed before submitting this pull request.

  • Read, understood, and followed the contributing guidelines.
  • Searched for existing issues and pull requests before creating this one.
  • Updated the example code block in the "Examples" section of the README.
  • Ensured the example follows existing project conventions (ES5 syntax).

@kohantikanath
Copy link
Contributor Author

Hi @Planeshifter,

Could you please review the code? I have raised a PR.

@Planeshifter Planeshifter changed the title Doc: improved README examples of random/strided/tools namespace docs: improve examples of random/strided/tools namespace Sep 8, 2024
@Planeshifter Planeshifter self-requested a review September 8, 2024 02:25
@Planeshifter Planeshifter added the Needs Review A pull request which needs code review. label Sep 8, 2024
@Planeshifter
Copy link
Member

Won't be able to merge this as the function signatures are incorrect and the example code cannot be executed successfully. Please only open PRs for code you have actually tested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Review A pull request which needs code review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: improve README examples of random/strided/tools namespace
2 participants