Skip to content

chore: address commit comments in README, benchmark, and main.c #5763

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

Merged
merged 12 commits into from
Mar 5, 2025

Conversation

Hecker165
Copy link
Contributor

Resolves #5712

Description

What is the purpose of this pull request?

This pull request:

  • Addresses review comments on commit 1f5d85a, which was part of PR Address commit comments (commit 1f5d85a) #5712.
  • Moves lines L155-158 to L250 in README.md.
  • Adds a missing closing and trailing comment in README.md.
  • Reorders variable declarations by length in benchmark.c.
  • Replaces stdlib_base_sqrt(2.0) with @stdlib/constants/float64/sqrt-two in C and JavaScript implementations.

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

@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Mar 3, 2025
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. 🏃 💨

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 3, 2025

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/normal/quantile $\color{green}306/306$
$\color{green}+100.00\%$
$\color{green}27/27$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}306/306$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

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!

Left comments on what needs to change for this to land.

@Planeshifter Planeshifter added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Mar 4, 2025
@Hecker165
Copy link
Contributor Author

Hi, @Planeshifter
I would really appreciate if you could help me fix the issue in my latest commit of this PR.

../src/main.c:23:10: fatal error: stdlib/constants/float64/sqrt_two.h: No such file or directory
   23 | #include "stdlib/constants/float64/sqrt_two.h"
      |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.

@Planeshifter Planeshifter changed the title Fix stdlib-bot comments in README, benchmark, and main.c chore: address commit comments in README, benchmark, and main.c Mar 5, 2025
Planeshifter
Planeshifter previously approved these changes Mar 5, 2025
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.

LGTM.

@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Mar 5, 2025
@stdlib-bot stdlib-bot removed the Needs Changes Pull request which needs changes before being merged. label Mar 5, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 5, 2025

PR Commit Message

chore: address commit comments in README, benchmark, and main.c

PR-URL: https://github.com/stdlib-js/stdlib/pull/5763
Closes: https://github.com/stdlib-js/stdlib/issues/5712

Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Abhay Punia <[email protected]>
Signed-off-by: Philipp Burckhardt <[email protected]>

Please review the above commit message and make any necessary adjustments.

@Planeshifter Planeshifter merged commit 70a7c2f into stdlib-js:develop Mar 5, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Ready To Merge A pull request which is ready to be merged. Statistics Issue or pull request related to statistical functionality.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Address commit comments (commit 1f5d85a)
3 participants