docs: fix return annotation values

Planeshifter · Planeshifter · commit 4589cee4e69b · 2025-08-20T15:36:48.000-05:00
---
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: passed
  - 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
---
diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/quantile/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/levy/quantile/lib/index.js
@@ -27,7 +27,7 @@
 * var quantile = require( '@stdlib/stats/base/dists/levy/quantile' );
 *
 * var y = quantile( 0.8, 0.0, 1.0 );
-* // returns ~1.386
+* // returns ~15.580
 *
 * @example
 * var factory = require( '@stdlib/stats/base/dists/levy/quantile' ).factory;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js
@@ -32,7 +32,7 @@
 * var mylogcdf = logcdf.factory( 3.0, 1.5 );
 *
 * var y = mylogcdf( 1.0 );
-* // returns ~-1.565
+* // returns ~-1.567
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/index.js
@@ -31,7 +31,7 @@
 *
 * var mylogpdf = logpdf.factory( 10.0, 2.0 );
 * y = mylogpdf( 10.0 );
-* // returns -2.079
+* // returns ~-2.079
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js
@@ -46,7 +46,7 @@
 * // returns ~-0.017
 *
 * y = mylogcdf( 2.5 );
-* // returns ~-0.113
+* // returns ~-0.114
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/pdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/pdf/lib/index.js
@@ -27,7 +27,7 @@
 * var pdf = require( '@stdlib/stats/base/dists/pareto-type1/pdf' );
 *
 * var y = pdf( 4.0, 1.0, 1.0 );
-* // returns ~0.044
+* // returns 0.0625
 *
 * y = pdf( 20.0, 1.0, 10.0 );
 * // returns 0.025
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/lib/index.js
@@ -33,7 +33,7 @@
 * // returns ~50.0
 *
 * y = quantile( 0.1, 1.0, 10.0 );
-* // returns ~10.541
+* // returns ~11.111
 *
 * var myquantile = quantile.factory( 2.5, 0.5 );
 * y = myquantile( 0.5 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/stdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/stdev/lib/index.js
@@ -27,10 +27,10 @@
 * var stdev = require( '@stdlib/stats/base/dists/pareto-type1/stdev' );
 *
 * var v = stdev( 4.0, 12.0 );
-* // returns 32.0
+* // returns ~5.657
 *
 * v = stdev( 8.0, 2.0 );
-* // returns ~0.109
+* // returns ~0.330
 *
 * v = stdev( 0.8, 1.0 );
 * // returns Infinity
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/cdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/planck/cdf/lib/index.js
@@ -27,17 +27,17 @@
 * var cdf = require( '@stdlib/stats/base/dists/planck/cdf' );
 *
 * var y = cdf( 2.0, 0.5 );
-* // returns 0.875
+* // returns ~0.777
 *
 * y = cdf( 2.0, 0.1 );
-* // returns ~0.271
+* // returns ~0.259
 *
 * var mycdf = cdf.factory( 0.5 );
 * y = mycdf( 3.0 );
-* // returns 0.9375
+* // returns ~0.865
 *
 * y = mycdf( 1.0 );
-* // returns 0.75
+* // returns ~0.632
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/index.js
@@ -33,7 +33,7 @@
 * // returns ~-3.6017
 *
 * y = logpmf( -1.0, 0.5 );
-* // returns 0.0
+* // returns -Infinity
 *
 * var mylogpmf = logpmf.factory( 0.5 );
 * y = mylogpmf( 3.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/t/logpdf/lib/index.js
@@ -27,11 +27,11 @@
 * var logpdf = require( '@stdlib/stats/base/dists/t/logpdf' );
 *
 * var y = logpdf( 3.0, 1.0 );
-* // returns ~-3.442
+* // returns ~-3.447
 *
 * var mylogPDF = logpdf.factory( 3.0 );
 * y = mylogPDF( 1.0 );
-* // returns ~-1.575
+* // returns ~-1.576
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/stdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/triangular/stdev/lib/index.js
@@ -27,7 +27,7 @@
 * var stdev = require( '@stdlib/stats/base/dists/triangular/stdev' );
 *
 * var v = stdev( 0.0, 1.0, 0.5 );
-* // returns ~0.205
+* // returns ~0.204
 *
 * v = stdev( 4.0, 12.0, 5.0 );
 * // returns ~1.78
diff --git a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/pdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/pdf/lib/index.js
@@ -31,7 +31,7 @@
 *
 * var mypdf = pdf.factory( -1.0, 1.0, 0.0, 1.0 );
 * y = mypdf( 0.9 );
-* // returns ~0.5896
+* // returns ~0.390
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/lib/index.js
@@ -27,7 +27,7 @@
 * var stdev = require( '@stdlib/stats/base/dists/uniform/stdev' );
 *
 * var v = stdev( 0.0, 1.0 );
-* // returns ~0.288
+* // returns ~0.289
 *
 * v = stdev( 4.0, 12.0 );
 * // returns ~2.309
diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/lib/index.js
@@ -27,11 +27,11 @@
 * var logpdf = require( '@stdlib/stats/base/dists/weibull/logpdf' );
 *
 * var y = logpdf( 2.0, 1.0, 0.5 );
-* // returns ~-3.297
+* // returns ~-3.307
 *
 * var mylogpdf = logpdf.factory( 7.0, 6.0 );
 * y = mylogpdf( 7.0 );
-* // returns ~-1.864
+* // returns ~-1.863
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/mgf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/weibull/mgf/lib/index.js
@@ -38,7 +38,7 @@
 * // returns ~3150.149
 *
 * y = myMGF( 0.08 );
-* // returns ~2.137s
+* // returns ~2.137
 */
 
 // MODULES //

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* var quantile = require( '@stdlib/stats/base/dists/levy/quantile' );`
`28`	`28`	`*`
`29`	`29`	`* var y = quantile( 0.8, 0.0, 1.0 );`
`30`		`-* // returns ~1.386`
	`30`	`+* // returns ~15.580`
`31`	`31`	`*`
`32`	`32`	`* @example`
`33`	`33`	`* var factory = require( '@stdlib/stats/base/dists/levy/quantile' ).factory;`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`* var mylogcdf = logcdf.factory( 3.0, 1.5 );`
`33`	`33`	`*`
`34`	`34`	`* var y = mylogcdf( 1.0 );`
`35`		`-* // returns ~-1.565`
	`35`	`+* // returns ~-1.567`
`36`	`36`	`*/`
`37`	`37`
`38`	`38`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`*`
`32`	`32`	`* var mylogpdf = logpdf.factory( 10.0, 2.0 );`
`33`	`33`	`* y = mylogpdf( 10.0 );`
`34`		`-* // returns -2.079`
	`34`	`+* // returns ~-2.079`
`35`	`35`	`*/`
`36`	`36`
`37`	`37`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@`
`46`	`46`	`* // returns ~-0.017`
`47`	`47`	`*`
`48`	`48`	`* y = mylogcdf( 2.5 );`
`49`		`-* // returns ~-0.113`
	`49`	`+* // returns ~-0.114`
`50`	`50`	`*/`
`51`	`51`
`52`	`52`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`* // returns ~50.0`
`34`	`34`	`*`
`35`	`35`	`* y = quantile( 0.1, 1.0, 10.0 );`
`36`		`-* // returns ~10.541`
	`36`	`+* // returns ~11.111`
`37`	`37`	`*`
`38`	`38`	`* var myquantile = quantile.factory( 2.5, 0.5 );`
`39`	`39`	`* y = myquantile( 0.5 );`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,10 @@`
`27`	`27`	`* var stdev = require( '@stdlib/stats/base/dists/pareto-type1/stdev' );`
`28`	`28`	`*`
`29`	`29`	`* var v = stdev( 4.0, 12.0 );`
`30`		`-* // returns 32.0`
	`30`	`+* // returns ~5.657`
`31`	`31`	`*`
`32`	`32`	`* v = stdev( 8.0, 2.0 );`
`33`		`-* // returns ~0.109`
	`33`	`+* // returns ~0.330`
`34`	`34`	`*`
`35`	`35`	`* v = stdev( 0.8, 1.0 );`
`36`	`36`	`* // returns Infinity`
Original file line number	Diff line number	Diff line change
`@@ -27,17 +27,17 @@`
`27`	`27`	`* var cdf = require( '@stdlib/stats/base/dists/planck/cdf' );`
`28`	`28`	`*`
`29`	`29`	`* var y = cdf( 2.0, 0.5 );`
`30`		`-* // returns 0.875`
	`30`	`+* // returns ~0.777`
`31`	`31`	`*`
`32`	`32`	`* y = cdf( 2.0, 0.1 );`
`33`		`-* // returns ~0.271`
	`33`	`+* // returns ~0.259`
`34`	`34`	`*`
`35`	`35`	`* var mycdf = cdf.factory( 0.5 );`
`36`	`36`	`* y = mycdf( 3.0 );`
`37`		`-* // returns 0.9375`
	`37`	`+* // returns ~0.865`
`38`	`38`	`*`
`39`	`39`	`* y = mycdf( 1.0 );`
`40`		`-* // returns 0.75`
	`40`	`+* // returns ~0.632`
`41`	`41`	`*/`
`42`	`42`
`43`	`43`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,11 @@`
`27`	`27`	`* var logpdf = require( '@stdlib/stats/base/dists/t/logpdf' );`
`28`	`28`	`*`
`29`	`29`	`* var y = logpdf( 3.0, 1.0 );`
`30`		`-* // returns ~-3.442`
	`30`	`+* // returns ~-3.447`
`31`	`31`	`*`
`32`	`32`	`* var mylogPDF = logpdf.factory( 3.0 );`
`33`	`33`	`* y = mylogPDF( 1.0 );`
`34`		`-* // returns ~-1.575`
	`34`	`+* // returns ~-1.576`
`35`	`35`	`*/`
`36`	`36`
`37`	`37`	`// MODULES //`