Skip to content

docs: update function description in JS benchmarks in stats/base/* #5135

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
Merged
merged 1 commit into from
Feb 9, 2025
Merged

docs: update function description in JS benchmarks in stats/base/* #5135

merged 1 commit into from
Feb 9, 2025

Conversation

aayush0325
Copy link
Member

Description

What is the purpose of this pull request?

This pull request:

  • minor changes in the function descriptions in JS benchmarks as observed in code review for other PRs

Related Issues

Does this pull request have any related issues?

No.

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

@aayush0325
docs: update function description in stats/base/* as per code review
a58c9df 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@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 9, 2025
@stdlib-bot
Copy link
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dnanmax $\color{green}380/380$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}380/380$
$\color{green}+100.00\%$
stats/base/dnanmaxabs $\color{green}382/382$
$\color{green}+100.00\%$ 		$\color{green}29/29$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}382/382$
$\color{green}+100.00\%$
stats/base/dnanmeanpw $\color{green}354/354$
$\color{green}+100.00\%$ 		$\color{green}13/13$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}354/354$
$\color{green}+100.00\%$
stats/base/dnanmeanwd $\color{green}402/402$
$\color{green}+100.00\%$ 		$\color{green}23/23$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}402/402$
$\color{green}+100.00\%$
stats/base/dnanmin $\color{green}381/381$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}381/381$
$\color{green}+100.00\%$
stats/base/dnanminabs $\color{green}381/381$
$\color{green}+100.00\%$ 		$\color{green}29/29$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}381/381$
$\color{green}+100.00\%$
stats/base/dnanrange $\color{green}386/386$
$\color{green}+100.00\%$ 		$\color{green}33/33$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}386/386$
$\color{green}+100.00\%$
stats/base/snanmax $\color{green}380/380$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}380/380$
$\color{green}+100.00\%$
stats/base/snanmaxabs $\color{green}380/380$
$\color{green}+100.00\%$ 		$\color{green}29/29$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}380/380$
$\color{green}+100.00\%$
stats/base/snanmeanors $\color{green}371/371$
$\color{green}+100.00\%$ 		$\color{green}23/23$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}371/371$
$\color{green}+100.00\%$
stats/base/snanmin $\color{green}380/380$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}380/380$
$\color{green}+100.00\%$
stats/base/snanminabs $\color{green}380/380$
$\color{green}+100.00\%$ 		$\color{green}29/29$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}380/380$
$\color{green}+100.00\%$
stats/base/snanrange $\color{green}387/387$
$\color{green}+100.00\%$ 		$\color{green}33/33$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}387/387$
$\color{green}+100.00\%$

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

kgryte
kgryte approved these changes Feb 9, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

LGTM

@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Feb 9, 2025
@kgryte kgryte changed the title docs: update function description in JS benchmarks of stats/base/* as per code review docs: update function description in JS benchmarks in stats/base/* Feb 9, 2025
@kgryte kgryte merged commit b78e8ba into stdlib-js:develop Feb 9, 2025
58 checks passed
@aayush0325 aayush0325 deleted the docs-stats-nan-packages branch February 9, 2025 09:56
saurabhraghuvanshii pushed a commit to saurabhraghuvanshii/stdlib-gs that referenced this pull request Feb 9, 2025
@aayush0325 @saurabhraghuvanshii
docs: update function description in JS benchmarks in stats/base/*
d3364ba 
PR-URL: stdlib-js#5135
Reviewed-by: Athan Reines <kgryte@gmail.com>

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: passed
  - task: run_c_examples
    status: passed
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: passed
  - task: run_c_benchmarks
    status: passed
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: passed
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: failed
---
saurabhraghuvanshii pushed a commit to saurabhraghuvanshii/stdlib-gs that referenced this pull request Feb 11, 2025
@aayush0325 @saurabhraghuvanshii
docs: update function description in JS benchmarks in stats/base/*
3b606ad 
PR-URL: stdlib-js#5135
Reviewed-by: Athan Reines <kgryte@gmail.com>
ShabiShett07 pushed a commit to ShabiShett07/stdlib that referenced this pull request Feb 26, 2025
@aayush0325 @ShabiShett07
docs: update function description in JS benchmarks in stats/base/*
d61f588 
PR-URL: stdlib-js#5135
Reviewed-by: Athan Reines <kgryte@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte kgryte approved these changes

Assignees
No one assigned
Labels
Documentation Improvements, additions, or changes to documentation. 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.
3 participants
@aayush0325 @stdlib-bot @kgryte