docs: improve README examples of stats/base/dists/cosine namespace
#2669
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
stdlib-bot
reviewed
Jul 26, 2024
|
Hi @Planeshifter, Could you please review the code? I have raised a PR. |
Planeshifter
changed the title
stats/base/dists/cosine namespace
Planeshifter
approved these changes
Oct 13, 2024
Planeshifter
added
the
Ready To Merge
PR Commit MessagePlease review the above commit message and make any necessary adjustments. |
aayush0325
pushed a commit
to aayush0325/stdlib
that referenced
this pull request
Nov 11, 2024
PR-URL: stdlib-js#2669 Closes: stdlib-js#1620 Co-authored-by: Kohantika Nath <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
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.
Resolves #1620
Description
This pull request:
Improves the README examples for the stats/base/dists/cosine 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
This pull request:
stats/base/dists/cosinenamespace #1620Questions
The updated example covers creating a distribution object, calculating properties, evaluating functions, generating random samples, and calculating moments. 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
The example uses ES5 syntax as per project conventions
No additional packages were required to create an informative example
Checklist
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).