stdlib-js / stdlib

✨ Standard library for JavaScript and Node.js. ✨
https://stdlib.io
Apache License 2.0
4.19k stars 406 forks source link

[RFC]: improve README examples of `constants/time` namespace #1562

Open Planeshifter opened 4 months ago

Planeshifter commented 4 months ago

Description

This RFC proposes to improve README examples of the constants/time 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:

Related Issues

None.

Questions

No.

Other

No.

Checklist

uditrajput03 commented 4 months ago

Hey @Planeshifter I am interested to do this , can you assign this to me

Planeshifter commented 4 months ago

@uditrajput03 Assigned! Thanks for looking into this. Please make sure to update the examples/index.js accordingly and to follow the project's code style conventions when writing the example code.