refector: Improve README examples for math/iter/special namespace
#1830
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The README file serves as a crucial entry point for users exploring a package. Hence, it's essential to provide clear and informative examples that demonstrate the package's functionality effectively. Prior to this commit, the README examples for the math/iter/special namespace were minimal and did not adequately showcase the available functionality. To address this, I have updated the README examples to include a more detailed demonstration of the `iterSqrt` function, which is one of the key functions within the namespace. This function iteratively computes the square root of each value in an array, making it a useful tool for certain mathematical applications. Additionally, I have included comments within the example code to provide further clarity on the functionality being demonstrated. These comments help guide users through the example and explain the purpose of each step. By improving the README examples in this manner, we aim to provide users with a better understanding of the capabilities offered by the math/iter/special namespace. This should ultimately enhance the overall user experience and make it easier for users to leverage the functionality provided by the package. This commit closes RFC stdlib-js#1578. Signed-off-by: Patel Prince <[email protected]>
prince-patel23
changed the title
Planeshifter
changed the title
math/iter/special namespace
Planeshifter
added
the
autoclose: Project Conventions
|
Thank you for working on this pull request. However, we cannot accept your contribution as this pull request does not follow project conventions. We place a high value on consistency throughout the stdlib codebase, and this pull request was found to significantly deviate from stdlib conventions. We encourage you to closely examine other packages in stdlib and attempt to emulate the practices and conventions found therein.
In short, the more effort you put in to ensure that your contribution looks and feels like stdlib—including variables names, bracket spacing, line breaks, etc—the more likely that your contribution will be reviewed and ultimately accepted. We encourage you to closely study the codebase before continuing to work on this pull request. Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses RFC #1578 by improving the README examples for the math/iter/special namespace package. The current README examples are minimal and not particularly informative, so this PR aims to provide more detailed and useful examples to showcase the functionality of the namespace.
Changes Made:
iterSqrtfunction from the math/iter/special namespace.Please review and provide feedback. Once approved, this PR can be merged.