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.

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

improve README examples of stats/base/dists/poisson namespace #1734

Merged
merged 3 commits into from
Mar 7, 2024
Merged

improve README examples of stats/base/dists/poisson namespace #1734

merged 3 commits into from
Mar 7, 2024

Conversation

nishant-s7
Copy link
Contributor

@nishant-s7 nishant-s7 commented Mar 6, 2024 •
edited
Loading

Resolves #1641

Description

What is the purpose of this pull request?

This pull request:

  • Add examples of the functions present in stats/base/dists/poisson namespace and their usage.
  • Adds example demonstration using 7 functions in the README.
  • Adds the same demonstration example in examples/index.js

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.

I've created a real-life use case to make it more interesting, which utilizes some commonly used functions of poisson distribution.

Checklist

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

@stdlib-js/reviewers

@nishant-s7
docs(examples): add examples to the documentation of poisson distribu…
2cdce0d 
…tion

Add examples to README file and examples/index.js file of poisson distribution.
stdlib-bot
stdlib-bot reviewed Mar 6, 2024
View reviewed changes
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. 🏃 💨

@Planeshifter Planeshifter self-requested a review March 6, 2024 13:55
@Planeshifter Planeshifter added Needs Review A pull request which needs code review. Documentation Improvements, additions, or changes to documentation. JavaScript Issue involves or relates to JavaScript. labels Mar 6, 2024
@Planeshifter
Apply suggestions from code review
55d0acf 
Signed-off-by: Philipp Burckhardt <[email protected]>
@Planeshifter
Copy link
Member

Thanks @nishant-s7 for your PR! Looks good, just keep in mind that per our style conventions we do not include a space in console annotations, so e.g. // => ~ 3.12 should be // => ~3.12.

Will merge once CI has passed.

@Planeshifter Planeshifter merged commit d66f5d6 into stdlib-js:develop Mar 7, 2024
6 checks passed
@Planeshifter Planeshifter removed the Needs Review A pull request which needs code review. label Mar 26, 2024
@nishant-s7 nishant-s7 mentioned this pull request Apr 1, 2024
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stdlib-bot stdlib-bot stdlib-bot left review comments

@Planeshifter Planeshifter Planeshifter approved these changes

Assignees
No one assigned
Labels
Documentation Improvements, additions, or changes to documentation. JavaScript Issue involves or relates to JavaScript.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[RFC]: improve README examples of stats/base/dists/poisson namespace
3 participants
@nishant-s7 @Planeshifter @stdlib-bot