Skip to content

docs: fix errors in the structure of READMEs in stats/base/* #5138

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: fix errors in the structure of READMEs in stats/base/* #5138

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:

  • fixes errors in the structure of READMEs in stats/base/*

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: fix errors in the structure of READMEs in stats/base/*
e67dc3f 
---
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: passed
  - 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: na
  - 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
@aayush0325
Copy link
Member Author

aayush0325 commented Feb 9, 2025 •
edited
Loading 


* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

I have updated all the packages to include this header before the actual documentation for the C implementations begins

reference: this PR

@stdlib-bot
Copy link
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/binomial/skewness $\color{green}177/177$
$\color{green}+100.00\%$ 		$\color{green}12/12$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}177/177$
$\color{green}+100.00\%$
stats/base/dists/binomial/variance $\color{green}176/176$
$\color{green}+100.00\%$ 		$\color{green}12/12$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}176/176$
$\color{green}+100.00\%$
stats/base/dists/cosine/cdf $\color{green}295/295$
$\color{green}+100.00\%$ 		$\color{green}33/33$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}295/295$
$\color{green}+100.00\%$
stats/base/dists/cosine/kurtosis $\color{green}180/180$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}180/180$
$\color{green}+100.00\%$
stats/base/dists/cosine/logcdf $\color{green}299/299$
$\color{green}+100.00\%$ 		$\color{green}33/33$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}299/299$
$\color{green}+100.00\%$
stats/base/dists/cosine/logpdf $\color{green}314/314$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}314/314$
$\color{green}+100.00\%$
stats/base/dists/cosine/median $\color{green}175/175$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}175/175$
$\color{green}+100.00\%$
stats/base/dists/cosine/mgf $\color{green}290/290$
$\color{green}+100.00\%$ 		$\color{green}19/19$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}290/290$
$\color{green}+100.00\%$
stats/base/dists/cosine/mode $\color{green}175/175$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}175/175$
$\color{green}+100.00\%$
stats/base/dists/cosine/pdf $\color{green}310/310$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}310/310$
$\color{green}+100.00\%$
stats/base/dists/cosine/skewness $\color{green}175/175$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}175/175$
$\color{green}+100.00\%$
stats/base/dists/cosine/stdev $\color{green}180/180$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}180/180$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/cdf $\color{green}301/301$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}301/301$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/entropy $\color{green}182/182$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}182/182$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/kurtosis $\color{green}184/184$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}184/184$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/mean $\color{green}181/181$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}181/181$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/median $\color{green}181/181$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}181/181$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/mgf $\color{green}315/315$
$\color{green}+100.00\%$ 		$\color{green}27/27$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}315/315$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/skewness $\color{green}181/181$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}181/181$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/stdev $\color{green}188/188$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}188/188$
$\color{green}+100.00\%$
stats/base/dists/discrete-uniform/variance $\color{green}182/182$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}182/182$
$\color{green}+100.00\%$
stats/base/dists/logistic/mode $\color{green}175/175$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}175/175$
$\color{green}+100.00\%$
stats/base/dmeankbn $\color{green}367/367$
$\color{green}+100.00\%$ 		$\color{green}18/18$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}367/367$
$\color{green}+100.00\%$
stats/base/dmeankbn2 $\color{green}366/366$
$\color{green}+100.00\%$ 		$\color{green}18/18$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}366/366$
$\color{green}+100.00\%$
stats/base/dmeanli $\color{green}359/359$
$\color{green}+100.00\%$ 		$\color{green}18/18$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}359/359$
$\color{green}+100.00\%$
stats/base/dmeanors $\color{green}351/351$
$\color{green}+100.00\%$ 		$\color{green}18/18$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}351/351$
$\color{green}+100.00\%$
stats/base/dmeanpw $\color{green}351/351$
$\color{green}+100.00\%$ 		$\color{green}18/18$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}351/351$
$\color{green}+100.00\%$
stats/base/dmidrange $\color{green}375/375$
$\color{green}+100.00\%$ 		$\color{green}29/29$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}375/375$
$\color{green}+100.00\%$
stats/base/dmin $\color{green}369/369$
$\color{green}+100.00\%$ 		$\color{green}25/25$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}369/369$
$\color{green}+100.00\%$
stats/base/dminabs $\color{green}369/369$
$\color{green}+100.00\%$ 		$\color{green}23/23$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}369/369$
$\color{green}+100.00\%$
stats/base/dminsorted $\color{green}318/318$
$\color{green}+100.00\%$ 		$\color{green}24/24$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}318/318$
$\color{green}+100.00\%$
stats/base/dmskmax $\color{green}412/412$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}412/412$
$\color{green}+100.00\%$
stats/base/dmskmin $\color{green}411/411$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}411/411$
$\color{green}+100.00\%$
stats/base/dmskrange $\color{green}413/413$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}413/413$
$\color{green}+100.00\%$
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/dnanmeanors $\color{green}363/363$
$\color{green}+100.00\%$ 		$\color{green}21/21$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}363/363$
$\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/dsmean $\color{green}346/346$
$\color{green}+100.00\%$ 		$\color{green}13/13$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}346/346$
$\color{green}+100.00\%$
stats/base/dsmeanors $\color{green}351/351$
$\color{green}+100.00\%$ 		$\color{green}18/18$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}351/351$
$\color{green}+100.00\%$
stats/base/dsmeanpw $\color{green}351/351$
$\color{green}+100.00\%$ 		$\color{green}18/18$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}351/351$
$\color{green}+100.00\%$
stats/base/dsmeanwd $\color{green}395/395$
$\color{green}+100.00\%$ 		$\color{green}20/20$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}395/395$
$\color{green}+100.00\%$
stats/base/dsnanmeanpn $\color{green}399/399$
$\color{green}+100.00\%$ 		$\color{green}26/26$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}399/399$
$\color{green}+100.00\%$
stats/base/dsnanmeanwd $\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/smskmax $\color{green}410/410$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}410/410$
$\color{green}+100.00\%$
stats/base/smskmin $\color{green}412/412$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}412/412$
$\color{green}+100.00\%$
stats/base/smskrange $\color{green}414/414$
$\color{green}+100.00\%$ 		$\color{green}31/31$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}414/414$
$\color{green}+100.00\%$

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

Planeshifter
Planeshifter approved these changes Feb 9, 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.

LGTM. Thanks for fixing these!

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

PR Commit Message

docs: fix errors in the structure of READMEs in `stats/base/*`

PR-URL: https://github.com/stdlib-js/stdlib/pull/5138

Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>

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

@Planeshifter Planeshifter merged commit d53a818 into stdlib-js:develop Feb 9, 2025
57 checks passed
saurabhraghuvanshii pushed a commit to saurabhraghuvanshii/stdlib-gs that referenced this pull request Feb 11, 2025
@aayush0325 @saurabhraghuvanshii
docs: fix errors in the structure of READMEs in stats/base/*
07157b1 
PR-URL: stdlib-js#5138

Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
@aayush0325 aayush0325 deleted the docs-readme-error-stats branch February 16, 2025 08:53
ShabiShett07 pushed a commit to ShabiShett07/stdlib that referenced this pull request Feb 26, 2025
@aayush0325 @ShabiShett07
docs: fix errors in the structure of READMEs in stats/base/*
5edfe5e 
PR-URL: stdlib-js#5138

Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
@aayush0325 aayush0325 mentioned this pull request Apr 3, 2025
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Planeshifter Planeshifter Planeshifter approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aayush0325 @stdlib-bot @Planeshifter