Skip to content
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

[RFC]: improve README examples of stats/base/dists/pareto-type1 namespace #1640

Open
3 tasks done
Planeshifter opened this issue Mar 3, 2024 · 0 comments · May be fixed by #2182
Open
3 tasks done

[RFC]: improve README examples of stats/base/dists/pareto-type1 namespace #1640

Planeshifter opened this issue Mar 3, 2024 · 0 comments · May be fixed by #2182
Labels
Good First Issue A good first issue for new contributors! JavaScript Issue involves or relates to JavaScript.

Comments

@Planeshifter
Copy link
Member

Description

This RFC proposes to improve the README examples of the stats/base/dists/pareto-type1 namespace package. Currently, namespace package READMEs only include minimal examples which are not particularly informative and do not showcase namespace functionality.

Historically, namespace examples were not given much effort due to the rapidly changing nature of the project; however, now that development and organization has settled, it would be good to revisit these packages and add proper examples to better communicate to users how to use namespace contents.

For those wanting to contribute to this issue, you can use the following steps:

  • Browse through the contents of the stats/base/dists/pareto-type1 namespace and identify interesting functions and packages to showcase.
  • Update the example code block in the "Examples" section of the README for the stats/base/dists/pareto-type1 namespace and open a PR.
  • When updating the README, examples should follow existing project conventions (e.g., ES5).
  • Examples may require functionality from other packages to help make examples more interesting.

Related Issues

None.

Questions

No.

Other

No.

Checklist

  • I have read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:.
@Planeshifter Planeshifter added Good First Issue A good first issue for new contributors! JavaScript Issue involves or relates to JavaScript. labels Mar 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue A good first issue for new contributors! JavaScript Issue involves or relates to JavaScript.
Projects
None yet
1 participant