Skip to content

Conversation

prince-patel23
Copy link

This pull request addresses RFC #1565 by enhancing the example code in the
index.js file located in the @stdlib/constants/uint8/examples directory.
The updated code improves the demonstration of the uint8 constants available
within the constants/uint8 namespace package.

Changes Made:

  • Improved the example code to showcase the available uint8 constants
  • Updated comments and header information to reflect current year
  • Ensured adherence to project conventions and licensing

Please review and merge as appropriate. Thank you!

…commit enhances the example code in index.js within the @stdlib/constants/uint8/examples directory. The updated code now showcases the available uint8 constants by listing their names in the console output.

This update aligns with RFC stdlib-js#1565, which aims to improve the README examples
of the constants/uint8 namespace package. By enhancing the example code in
index.js, users can better understand how to access and utilize the uint8
constants provided by the package.

The revised code imports the constants module from @stdlib/constants/uint8,
extracts the names of the available constants using Object.keys(), and then
prints out these names to the console. This provides a more informative output
that demonstrates the functionality of the constants/uint8 namespace.



Signed-off-by: Patel Prince <[email protected]>
@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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants