Skip to content

updated comments #5520

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

updated comments #5520

wants to merge 3 commits into from

Conversation

ChaitraTM
Copy link

@ChaitraTM ChaitraTM commented Feb 28, 2025 •
edited
Loading

Resolves #5431.

Description

What is the purpose of this pull request?

This pull request:

  • Updates the return value in the example to match similar values as Line 61.
  • Reorders variables in example.c based on length.
  • Renames the logcdf variable to cdf in benchmark.native.js for consistency.
  • Fixes incorrect distribution description in cdf.h (Weibull → Cauchy).

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. labels Feb 28, 2025
@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!

@stdlib-bot stdlib-bot added the Good First PR A pull request resolving a Good First Issue. label Feb 28, 2025
stdlib-bot
stdlib-bot reviewed Feb 28, 2025
View reviewed changes
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 Feb 28, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/cauchy/cdf $\color{green}287/287$
$\color{green}+100.00\%$ 		$\color{green}19/19$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}287/287$
$\color{green}+100.00\%$

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

Planeshifter
Planeshifter reviewed Mar 1, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/README.md
@@ -213,9 +213,10 @@ static double random_uniform( const double min, const double max ) {
}

int main( void ) {
//correct order based on the length
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added comments here and elsewhere in this PR need to be removed.

Planeshifter
Planeshifter requested changes Mar 1, 2025
View reviewed changes
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 opening a PR!

Left a few comments that need to be resolved before this can move forward.

@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 1, 2025
@ChaitraTM ChaitraTM requested a review from Planeshifter March 2, 2025 11:00
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Mar 2, 2025
@Planeshifter
Copy link
Member

@ChaitraTM Please don't mark conversations as resolved until the issues are addressed. Notice also the failing CI checks, which contain additional information on what needs to be resolved. Thanks!

kgryte
kgryte reviewed Mar 17, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/README.md
@@ -213,9 +213,10 @@ static double random_uniform( const double min, const double max ) {
}

int main( void ) {
//correct order based on the length
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
//correct order based on the length

kgryte
kgryte reviewed Mar 17, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/benchmark/benchmark.native.js
@@ -31,10 +31,10 @@ var pkg = require( './../package.json' ).name;


// VARIABLES //

var logcdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
//corected variable name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
//corected variable name

kgryte
kgryte reviewed Mar 17, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/examples/c/example.c
@@ -26,11 +26,13 @@ static double random_uniform( const double min, const double max ) {
}

int main( void ) {
double gamma;
//corrected order
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
//corrected order

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ChaitraTM This order is not correct. The order should be in order of decreasing length, not increasing length.

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Mar 17, 2025
@Planeshifter
Copy link
Member

Closing this PR since #6192 got merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte kgryte left review comments

@stdlib-bot stdlib-bot stdlib-bot left review comments

@Planeshifter Planeshifter Awaiting requested review from Planeshifter

Assignees
No one assigned
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. Needs Changes Pull request which needs changes before being merged. Statistics Issue or pull request related to statistical functionality.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Address commit comments (commit 8fa3827)
4 participants
@ChaitraTM @stdlib-bot @Planeshifter @kgryte