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

Enhanced README Examples for number/int32 Namespace #2703

Closed
wants to merge 2 commits into from

Conversation

CodeMaverick2
Copy link

@CodeMaverick2 CodeMaverick2 commented Jul 29, 2024

Issue -> #1597

Description :

This PR enhances the README documentation for the number/int32 namespace by adding comprehensive and illustrative examples. The previous examples were minimal and did not fully showcase the functionality provided by the number/int32 namespace. This improvement aims to provide users with clear and practical examples to better understand and utilize the utilities within this namespace.


Changes Made

  1. Updated README:

    • Added detailed examples for various utilities within the number/int32 namespace.
    • Examples now cover:
      • Converting numbers to signed 32-bit integers.
      • Performing bitwise operations (AND, OR, XOR, NOT, shifts).
      • Checking and manipulating signed 32-bit integers.
      • Performing mathematical operations (addition, subtraction, multiplication, division, modulo, negation).
      • Using other packages in conjunction with number/int32.
  2. Updated index.js:

    • Included all examples present in the README to ensure consistency and provide a practical implementation reference.
    • Demonstrated the use of the base sub-namespace for performing various operations on signed 32-bit integers.

Impact

  • Enhanced Documentation: Improves the clarity and usefulness of the README documentation for the number/int32 namespace.
  • Practical Examples: Provides users with practical examples to better understand and utilize the utilities within this namespace.
  • Consistency: Ensures consistency between the README and example implementation in index.js.

@stdlib-bot
Copy link
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@Planeshifter
Copy link
Member

PR aims to add examples for usage of number/int32, but the added examples are for number/int32/base instead. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants