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

docs(math/base/ops): improve math/base/ops README.md examples #1722

Merged

Conversation

EuniceSim142
Copy link
Contributor

@EuniceSim142 EuniceSim142 commented Mar 6, 2024

Resolves #1569 .

Description

What is the purpose of this pull request?

This pull request:

  • Adds examples for methods in math/base/ops namespace
  • Updates ReadMe.md with the same methods.

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.


@stdlib-js/reviewers

Copy link
Contributor

@stdlib-bot stdlib-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

@Planeshifter Planeshifter self-requested a review March 6, 2024 13:55
@Planeshifter Planeshifter added Needs Review A pull request which needs code review. Documentation Improvements, additions, or changes to documentation. JavaScript Issue involves or relates to JavaScript. labels Mar 6, 2024
@Planeshifter Planeshifter changed the title docs(math/base/ops): improve math/base/ops README.md examples docs(math/base/ops): improve math/base/ops README.md examples Mar 6, 2024
Signed-off-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Philipp Burckhardt <[email protected]>
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! Will merge once CI has passed.

Made a few edits. Please be aware that comment annotations of the form // => (for console.log printouts) or // returns (for return values) should always be included in the next line. This follows project conventions and also ensures that our linting tooling can verify that the annotations are correct.

Signed-off-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Philipp Burckhardt <[email protected]>
@EuniceSim142
Copy link
Contributor Author

Thank you for taking time to review! Will take note of these details in future 😄

Signed-off-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Philipp Burckhardt <[email protected]>
@Planeshifter Planeshifter merged commit ad45e04 into stdlib-js:develop Mar 7, 2024
6 checks passed
@Planeshifter Planeshifter removed the Needs Review A pull request which needs code review. label Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements, additions, or changes to documentation. JavaScript Issue involves or relates to JavaScript.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: improve README examples of math/base/ops namespace
3 participants