Skip to content

Commit 6f20eb8

Browse files
committed
fix: correct README variance reference and convert C docs to Doxygen format
--- 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: passed - 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 ---
1 parent 6f85b23 commit 6f20eb8

File tree

2 files changed

+6
-6
lines changed
  • lib/node_modules/@stdlib/stats/base/dists/arcsine/quantile

2 files changed

+6
-6
lines changed

lib/node_modules/@stdlib/stats/base/dists/arcsine/quantile/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ logEachMap( 'p: %0.4f, a: %0.4f, b: %0.4f, Q(p;a,b): %0.4f', p, a, b, quantile )
163163

164164
#### stdlib_base_dists_arcsine_quantile( p, a, b )
165165

166-
Returns the variance of an arcsine distribution.
166+
Evaluates the quantile function for an arcsine distribution.
167167

168168
```c
169169
double out = quantile( 0.8, 0.0, 1.0 );

lib/node_modules/@stdlib/stats/base/dists/arcsine/quantile/src/main.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@
2727
/**
2828
* Evaluates the quantile function for an arcsine distribution with minimum support `a` and maximum support `b` at a probability `p`.
2929
*
30-
* @param {Probability} p - input value
31-
* @param {number} a - minimum support
32-
* @param {number} b - maximum support
33-
* @returns {number} evaluated quantile function
30+
* @param p input value
31+
* @param a minimum support
32+
* @param b maximum support
33+
* @return evaluated quantile function
3434
*
3535
* @example
36-
* var y = quantile( 0.8, 0.0, 1.0 );
36+
* double y = stdlib_base_dists_arcsine_quantile( 0.8, 0.0, 1.0 );
3737
* // returns ~0.905
3838
*/
3939
double stdlib_base_dists_arcsine_quantile( const double p, const double a, const double b ) {

0 commit comments

Comments
 (0)