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

docs: fix return value #5184

Merged
merged 1 commit into from
Feb 13, 2025

Conversation

ekambains
Copy link
Contributor

Resolves #5148

Description

What is the purpose of this pull request?

This pull request:

  • Changed the return value description in the comment

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

Signed-off-by: ekambains <bainsinbusiness@gmail.com>
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Feb 11, 2025
@stdlib-bot
Copy link
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/geometric/stdev $\color{green}166/166$
$\color{green}+100.00\%$
$\color{green}9/9$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}166/166$
$\color{green}+100.00\%$

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

@Planeshifter Planeshifter changed the title bench: change return value docs: fix return value Feb 13, 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.

Looks good, thank you! Only small note that commit should have started with docs: instead of bench:, given that it only touches documentation.

@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Feb 13, 2025
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Feb 13, 2025
@stdlib-bot
Copy link
Contributor

PR Commit Message

docs: fix return value

PR-URL: https://github.com/stdlib-js/stdlib/pull/5184
Closes: https://github.com/stdlib-js/stdlib/issues/5148

Co-authored-by: ekambains <bainsinbusiness@gmail.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Signed-off-by: ekambains <bainsinbusiness@gmail.com>

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

@Planeshifter Planeshifter merged commit 70019dd into stdlib-js:develop Feb 13, 2025
58 checks passed
@ekambains
Copy link
Contributor Author

Thank You for pointing it out, will take care next time.

@ekambains ekambains deleted the bench/return-value-change branch February 13, 2025 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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 0eac653)
3 participants