-
-
Notifications
You must be signed in to change notification settings - Fork 907
docs(stats/base/dists/arcsine): improve examples #2684
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.
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
Conversation
There was a problem hiding this 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 please have a look at the improved examples for |
There was a problem hiding this 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
.
@Planeshifter I have done the required changes to |
@kgryte @Planeshifter please merge this PR, you seem to have closed the issue before the merger of the PR. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please revert these changes.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this 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.
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! |
Resolves #1612
Description
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
Questions
No.
Other
No.
Checklist
@stdlib-js/reviewers