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

Improved README examples of number/float32/base namespace #2695

Closed
wants to merge 2 commits into from

Conversation

CodeMaverick2
Copy link

@CodeMaverick2 CodeMaverick2 commented Jul 28, 2024

Issue -> #1591

Description

This pull request aims to enhance the @stdlib/constants/float32 namespace package by providing detailed examples in the README file and updating the index.js file in the examples directory. These additions are designed to improve the documentation and usability of the package, offering users clear guidance on how to utilize the provided constants effectively.

Changes :

  1. README File Enhancements:

    • Added detailed examples for each constant in the @stdlib/constants/float32 namespace.
    • Included expected output for each example to aid user understanding.
  2. Examples Directory Update:

    • Updated index.js to include comprehensive examples for each constant.
    • Utilized float32ToBinaryString from @stdlib/number/float32/base/to-binary-string to demonstrate binary representations where applicable.
    • Maintained the original structure and license information while enhancing the content with practical examples.

Task Check :

  • Improved Documentation: Provides users with clear, practical examples for each constant, making the package more user-friendly.

  • Enhanced Usability: Helps users quickly understand the functionality and application of each constant.

  • Consistent Output Demonstrations: Sample outputs are included to show the expected results of each example, improving comprehension.

  • Read, understood, and followed the contributing guidelines

Signed-off-by: Tejas Ghatule <141946130+CodeMaverick2@users.noreply.github.com>
Signed-off-by: Tejas Ghatule <141946130+CodeMaverick2@users.noreply.github.com>
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
Copy link
Member

PR aims to add examples for namespace @stdlib/constants/float32 but changes contents of a different namespace, @stdlib/number/float32/base. Closing this PR.

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