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 README examples of stats/base/dists/cosine namespace #2669

Merged
merged 2 commits into from
Oct 13, 2024

Conversation

kohantikanath
Copy link
Contributor

@kohantikanath kohantikanath commented Jul 26, 2024

Resolves #1620

Description

What is the purpose of this pull request?

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

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 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

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

  • No additional packages were required to create an 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).

Copy link
Contributor

@stdlib-bot stdlib-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Hi there! 👋

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

@kohantikanath
Copy link
Contributor Author

Hi @Planeshifter,

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

@Planeshifter Planeshifter added the Needs Review A pull request which needs code review. label Sep 8, 2024
@Planeshifter Planeshifter self-requested a review September 8, 2024 02:26
@Planeshifter Planeshifter changed the title Docs: improved README examples of stats/base/dists/cosine namespace docs: improve README examples of stats/base/dists/cosine namespace Sep 8, 2024
@Planeshifter Planeshifter removed the Needs Review A pull request which needs code review. label Oct 13, 2024
@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Oct 13, 2024
@stdlib-bot
Copy link
Contributor

PR Commit Message

docs: improve README examples of `stats/base/dists/cosine` namespace

PR-URL: https://github.com/stdlib-js/stdlib/pull/2669
Closes: https://github.com/stdlib-js/stdlib/issues/1620

Co-authored-by: Kohantika Nath <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

Please review the above commit message and make any necessary adjustments.

@Planeshifter Planeshifter merged commit e5b993a into stdlib-js:develop Oct 13, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ready To Merge A pull request which is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: improve README examples of stats/base/dists/cosine namespace
3 participants