stdlib icon indicating copy to clipboard operation
stdlib copied to clipboard

[RFC]: improve README examples of `math/special` namespace

Open Planeshifter opened this issue 1 year ago • 3 comments

Description

This RFC proposes to improve the README examples of the math/special 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 math/special namespace and identify interesting functions and packages to showcase.
  • Update the example code block in the "Examples" section of the README for the math/special 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

  • [X] I have read and understood the Code of Conduct.
  • [X] Searched for existing issues and pull requests.
  • [X] The issue name begins with RFC:.

Planeshifter avatar Mar 03 '24 02:03 Planeshifter

Does math/special have only one function?

suredesm avatar Mar 31 '24 21:03 suredesm

@suredesm Good call! It's currently missing a lot of functions because we didn't have time to roll them out yet. It's probably better to revisit this issue once the namespace is more populated.

Planeshifter avatar Mar 31 '24 21:03 Planeshifter

May I know what types of functionality expected under math/special because already there is math/base/special providing math functionalities. That'd be very helpful to comeup with some ideas for this.

suredesm avatar Apr 01 '24 03:04 suredesm