stdlib
stdlib copied to clipboard
stdlib-js
docs: improve examples of `stats/base/dists/chisquare` namespace
Resolves: #1619
Description
What is the purpose of this pull request?
This pull request:
- Improves the README examples for the stats/base/dists/chisquare 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:
- Resolves [RFC]: Improve README examples for stats/base/dists/chisquare namespace package #1619
Questions
Any questions for reviewers of this pull request?
- The updated example covers creating a distribution object, calculating properties, evaluating probability 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?
- The example uses ES5 syntax as per project conventions
- An additional package (@stdlib/math/base/special/round) was used to improve readability of the output
Checklist
Please ensure the following tasks are completed before submitting this pull request.
- [x] Read, understood, and followed the contributing guidelines.
- [x] Searched for existing issues and pull requests before creating this one.
- [x] Updated the example code block in the "Examples" section of the README.
- [x] Ensured the example follows existing project conventions (ES5 syntax).
Hi @Planeshifter,
Could you please review the code? I have raised a PR.
Coverage Report
| Package | Statements | Branches | Functions | Lines |
|---|---|---|---|---|
| stats/base/dists/chisquare | $\color{green}168/168$ $\color{green}+100.00\%$ |
$\color{green}1/1$ $\color{green}+100.00\%$ |
$\color{green}0/0$ $\color{green}+100.00\%$ |
$\color{green}168/168$ $\color{green}+100.00\%$ |
The above coverage report was generated for the changes in this PR.
PR Commit Message
docs: improve examples of `stats/base/dists/chisquare` namespace
PR-URL: https://github.com/stdlib-js/stdlib/pull/2678
Closes: https://github.com/stdlib-js/stdlib/issues/1619
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.