Skip to content

Conversation

uditrajput03
Copy link

Resolves #1562

Description

What is the purpose of this pull request?

This pull request:

  • Add examples of the functions present in constant/time namespace and their usage.
  • Adds example demonstration in the README.
  • Adds the same demonstration example in examples/index.js

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

improve README examples of constants/time namespace

Signed-off-by: Udit Rajput <[email protected]>
Added new examples same as README.md

Signed-off-by: Udit Rajput <[email protected]>
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 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 8, 2024
@Planeshifter Planeshifter added the autoclose: Project Conventions Pull request which should be auto-closed due to not following project conventions. label Sep 7, 2024
@stdlib-bot
Copy link
Contributor

Thank you for working on this pull request. However, we cannot accept your contribution as this pull request does not follow project conventions.

We place a high value on consistency throughout the stdlib codebase, and this pull request was found to significantly deviate from stdlib conventions. We encourage you to closely examine other packages in stdlib and attempt to emulate the practices and conventions found therein.

  • If you are attempting to contribute a new package, sometimes the best approach is to simply copy the contents of an existing package and then modify the minimum amount necessary to implement the feature (e.g., changing descriptions, parameter names, and implementation).
  • If you are contributing tests, find a package implementing a similar feature and emulate the tests of that package.
  • If you are updating documentation, examine several similar packages and emulate the content, style, and prose of those packages.

In short, the more effort you put in to ensure that your contribution looks and feels like stdlib—including variables names, bracket spacing, line breaks, etc—the more likely that your contribution will be reviewed and ultimately accepted. We encourage you to closely study the codebase before continuing to work on this pull request.

Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.

@stdlib-bot stdlib-bot closed this Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autoclose: Project Conventions Pull request which should be auto-closed due to not following project conventions. Documentation Improvements, additions, or changes to documentation. JavaScript Issue involves or relates to JavaScript. Needs Review A pull request which needs code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants