stdlib icon indicating copy to clipboard operation
stdlib copied to clipboard
verified publisher icon stdlib-js

docs(stats/base/dists/arcsine): improve examples

Open mayank1365 opened this issue 1 year ago • 3 comments

Resolves #1612

Description

What is the purpose of this pull request?

This pull request:

  • a. Enhances Documentation: Improves the README examples for the stats/base/dists/arcsine namespace. It adds more detailed and varied examples to better illustrate the use of different functions available in the arcsine distribution, such as cdf, pdf, mean, variance, and others.

  • b. Provides Practical Usage: Includes practical examples demonstrating the calculation of statistical properties (e.g., median, mode, entropy) and the generation of random numbers. This helps users understand how to apply the library functions in real-world scenarios and ensures they can effectively utilize the arcsine distribution in their own projects.

Related Issues

Does this pull request have any related issues?

  • resolves: Improves documentation clarity by adding more comprehensive examples for the stats/base/dists/arcsine namespace.
  • fixes: Updates and corrects existing examples to better demonstrate the usage of various functions and properties related to the arcsine distribution.

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.

No.

Checklist

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

@stdlib-js/reviewers

mayank1365 avatar Jul 27 '24 19:07 mayank1365

@Planeshifter please have a look at the improved examples for stats/base/dists/arcsine

mayank1365 avatar Jul 28 '24 07:07 mayank1365

Can you please move everything inside a single example code block?

You should also update the examples/index.js file to match the example code block from the README.md.

@Planeshifter I have done the required changes to examples/index.js and I have moved everything inside a single example code block in the README.md.

mayank1365 avatar Jul 28 '24 15:07 mayank1365

@kgryte @Planeshifter please merge this PR, you seem to have closed the issue before the merger of the PR.

mayank1365 avatar Jul 29 '24 20:07 mayank1365

This pull request has been automatically closed because it has been inactive for an extended period after changes were requested. If you still wish to pursue this contribution, feel free to reopen the pull request or submit a new one.

We appreciate your interest in contributing to stdlib!

stdlib-bot avatar Oct 13 '24 20:10 stdlib-bot