Skip to content

Conversation

mayank1365
Copy link

@mayank1365 mayank1365 commented Jul 27, 2024

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

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. 🏃 💨

@mayank1365
Copy link
Author

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

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.

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.

@mayank1365
Copy link
Author

mayank1365 commented Jul 28, 2024

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 mayank1365 requested a review from Planeshifter July 29, 2024 07:24
@mayank1365
Copy link
Author

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

Copy link
Member

Choose a reason for hiding this comment

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

This file should not have been modified.

Copy link
Member

Choose a reason for hiding this comment

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

Please revert these changes.

Copy link
Author

Choose a reason for hiding this comment

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

Planetshifter told to change that file as well.

Copy link
Member

Choose a reason for hiding this comment

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

No, he meant the examples/index.js in the namespace package, not in the root directory.

Copy link
Author

Choose a reason for hiding this comment

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

oh ok I will fix the files accordingly and revert the necessary files back

Copy link
Author

Choose a reason for hiding this comment

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

quick doubt how should i handle this, i am getting this error in examples/index.js in root as well as the namespace package

  25:1  warning  Unexpected console statement                                     no-console
  28:1  error    All 'var' declarations must be at the top of the function scope  vars-on-top
  29:1  warning  Unexpected console statement                                     no-console

Copy link
Author

Choose a reason for hiding this comment

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

Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

This PR needs to be updated before it can be considered for review.

@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. Needs Changes Pull request which needs changes before being merged. labels Jul 29, 2024
@mayank1365 mayank1365 requested a review from kgryte August 1, 2024 07:36
@Planeshifter Planeshifter added the autoclose: Stale Pull request which should be auto-closed as considered stale. label Oct 13, 2024
@stdlib-bot
Copy link
Contributor

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 stdlib-bot closed this Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autoclose: Stale Pull request which should be auto-closed as considered stale. Documentation Improvements, additions, or changes to documentation. Needs Changes Pull request which needs changes before being merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[RFC]: improve README examples of stats/base/dists/arcsine namespace

4 participants