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

docs: improve README examples of stats/base/dists/negative-binomial #1774

Merged
merged 4 commits into from
Mar 12, 2024
Merged

docs: improve README examples of stats/base/dists/negative-binomial #1774

merged 4 commits into from
Mar 12, 2024

Conversation

Rejoan-Sardar
Copy link
Contributor

@Rejoan-Sardar Rejoan-Sardar commented Mar 8, 2024 •
edited
Loading

Resolves #1637 .

Description

What is the purpose of this pull request?

This pull request:

  • Add examples of the functions present in stats/base/dists/negative-binomial 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 negative binomial distribution.

Checklist

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

  • Read, understood, and followed the [contributing guidelines][contributing].

@stdlib-js/reviewers

@Planeshifter Planeshifter changed the title feat: improve README examples of stats/base/dists/negative-binomial namespace feat: improve README examples of stats/base/dists/negative-binomial namespace Mar 8, 2024
@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 8, 2024
@Rejoan-Sardar
Copy link
Contributor Author

Rejoan-Sardar commented Mar 9, 2024 •
edited
Loading

@Planeshifter, @Pranavchiku can u guys review this PR?

Pranavchiku
Pranavchiku approved these changes Mar 10, 2024
View reviewed changes
Copy link
Member

@Pranavchiku Pranavchiku left a comment

Choose a reason for hiding this comment

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

Looks fine. I am not the best person to review this. At a glance, this looks good.

@Rejoan-Sardar
Copy link
Contributor Author

@kgryte please review it,and let me know if any changes need to be made

@Planeshifter
Apply suggestions from code review
960dc07 
Signed-off-by: Philipp Burckhardt <[email protected]>
@Planeshifter
Apply suggestions from code review
1ee58cd 
Signed-off-by: Philipp Burckhardt <[email protected]>
@Planeshifter
Apply suggestions from code review
c31bdc1 
Signed-off-by: Philipp Burckhardt <[email protected]>
@Planeshifter Planeshifter changed the title feat: improve README examples of stats/base/dists/negative-binomial namespace docs: improve README examples of stats/base/dists/negative-binomial Mar 12, 2024
Planeshifter
Planeshifter approved these changes Mar 12, 2024
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks! Example looks good and is a definite improvement; I added spaces around function parentheses and rounded console.log annotations to three digits after decimal point.

Will merge once CI passes.

@Planeshifter Planeshifter merged commit 37f46fe into stdlib-js:develop Mar 12, 2024
6 checks passed
@Rejoan-Sardar Rejoan-Sardar deleted the negative-binomial branch March 12, 2024 05:59
@Rejoan-Sardar Rejoan-Sardar mentioned this pull request Mar 17, 2024
Closed
1 task
@Rejoan-Sardar Rejoan-Sardar mentioned this pull request Mar 18, 2024
Closed
5 tasks
@Planeshifter Planeshifter removed the Needs Review A pull request which needs code review. label Mar 26, 2024
@Rejoan-Sardar Rejoan-Sardar 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

@Pranavchiku Pranavchiku Pranavchiku approved these changes

@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/negative-binomial namespace
3 participants
@Rejoan-Sardar @Planeshifter @Pranavchiku