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 ndarray/iter namespace #1589

Closed
3 tasks done
Planeshifter opened this issue Mar 3, 2024 · 2 comments · May be fixed by #1686
Closed
3 tasks done

[RFC]: improve README examples of ndarray/iter namespace #1589

Planeshifter opened this issue Mar 3, 2024 · 2 comments · May be fixed by #1686
Assignees
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 ndarray/iter 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 ndarray/iter namespace and identify interesting functions and packages to showcase.
  • Update the example code block in the "Examples" section of the README for the ndarray/iter 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
@performant23
Copy link
Contributor

performant23 commented Mar 3, 2024

Hello, I hope this message finds you well! At the moment, I don’t have any significant issues to address (although I anticipate some minor adjustments for #1437). Therefore, I would be delighted to contribute to this issue. Given that we’ll be exploring similar packages and the patterns for examples in ndarray would be alike, I would also be more than happy to work on #1588, #1587, and #1586 if that works for you. Thank You!

@Planeshifter
Copy link
Member Author

Planeshifter commented Mar 3, 2024

@performant23 Your open PR should be ready for merging, so this sounds good. And it makes sense to treat the linked issues as one. Thanks for taking this on!

When updating the README.md examples, please make sure to also update the examples/index.js file(s) accordingly.

performant23 added a commit to performant23/stdlib that referenced this issue Mar 4, 2024
Updated examples to span over the functionalities implemented in the namespace.

Addresses: stdlib-js#1589
performant23 added a commit to performant23/stdlib that referenced this issue Mar 4, 2024
Updated example for the namespace using functionalities from stats, random, and ndarray

Fixes: stdlib-js#1589
@kgryte kgryte closed this as completed Jul 29, 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
Development

Successfully merging a pull request may close this issue.

3 participants