Skip to content

docs: improve README examples of stats/base/dists/normal namespace #1679

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
Merged
merged 4 commits into from
Jun 8, 2024
Merged

docs: improve README examples of stats/base/dists/normal namespace #1679

merged 4 commits into from
Jun 8, 2024

Conversation

nightknighto
Copy link
Contributor

Resolves #1638

Description

What is the purpose of this pull request?

This pull request:

  • Add examples of the functions present in stats/base/dists/normal namespace and their usage.
  • Adds 4 example sets in the README.
  • Adds 4 example js files corresponding to the new sets.

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 made a separate js file for each example set to not put all codes together and to make it more tidy, manageable and independent.

Checklist

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

@stdlib-js/reviewers

stdlib-bot
stdlib-bot reviewed Mar 3, 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 added Needs Review A pull request which needs code review. Documentation Improvements, additions, or changes to documentation. labels Mar 4, 2024
kgryte
kgryte reviewed Mar 4, 2024
View reviewed changes
@nightknighto nightknighto requested a review from kgryte March 8, 2024 09:25
@nightknighto nightknighto mentioned this pull request Mar 21, 2024
Closed
6 tasks
@nightknighto
Copy link
Contributor Author

@Planeshifter @kgryte

@Planeshifter Planeshifter self-requested a review June 8, 2024 01:59
Planeshifter
Planeshifter approved these changes Jun 8, 2024
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

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

Thanks @Deadreyo!

I have added an overarching scenario for the example code and updated the code style to follow project conventions (e.g., use spaces around function parentheses.)

Will merge once CI checks have passed.

@Planeshifter Planeshifter merged commit 922122e into stdlib-js:develop Jun 8, 2024
7 checks passed
aman-095 pushed a commit to aman-095/stdlib that referenced this pull request Jun 13, 2024
@nightknighto @Planeshifter @aman-095
docs: improve examples for stats/base/dists/normal namespace
2b21fc8 
PR-URL: stdlib-js#1679
Closes: stdlib-js#1638

---------

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
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

@kgryte kgryte Awaiting requested review from kgryte

Assignees
No one assigned
Labels
Documentation Improvements, additions, or changes to documentation. Needs Review A pull request which needs code review.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[RFC]: improve README examples of stats/base/dists/normal namespace
4 participants
@nightknighto @Planeshifter @kgryte @stdlib-bot