Skip to content

[RFC]: improve README examples of stats/base namespace #1650

Closed

Description

Description

This RFC proposes to improve the README examples of the stats/base 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 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 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:.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    Good First IssueA good first issue for new contributors!JavaScriptIssue involves or relates to JavaScript.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions