[RFC]: improve README examples in namespace packages #1329
Labels
Accepted
RFC feature request which has been accepted.
difficulty: 1
Low degree of difficulty. Should be straightforward to implement and/or resolve.
Documentation
Improvements, additions, or changes to documentation.
Good First Issue
A good first issue for new contributors!
JavaScript
Issue involves or relates to JavaScript.
priority: Normal
Normal priority concern or feature request.
RFC
Request for comments. Feature requests and proposed changes.
Description
This RFC proposes improving README examples in namespace packages. Currently, namespace package READMEs only include minimal examples which are not particularly informative and do not showcase namespace functionality. For example, see
@stdlib/array
.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:
require
functionality from other packages to help make examples more interesting.Related Issues
None.
Questions
No.
Other
No.
Checklist
RFC:
.The text was updated successfully, but these errors were encountered: