docs: fix return annotation values

Planeshifter · Planeshifter · commit e678757c9a62 · 2025-08-20T15:29:36.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/beta/mgf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/beta/mgf/lib/index.js
@@ -44,7 +44,7 @@
 * var mgf = factory( 0.5, 0.5 );
 *
 * var y = mgf( 0.8 );
-* // returns ~1.522
+* // returns ~1.552
 *
 * y = mgf( 0.3 );
 * // returns ~1.168
diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/quantile/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/beta/quantile/lib/index.js
@@ -41,7 +41,7 @@
 * // returns ~0.713
 *
 * y = quantile( 0.4 );
-* // returns ~0.5
+* // returns ~0.433
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/skewness/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/beta/skewness/lib/index.js
@@ -33,7 +33,7 @@
 * // returns ~0.529
 *
 * v = skewness( 8.0, 2.0 );
-* // returns ~0.829
+* // returns ~-0.829
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf/lib/index.js
@@ -38,10 +38,10 @@
 * var logcdf = factory( 0.5, 0.5 );
 *
 * var y = logcdf( 0.8 );
-* // returns ~-0.766
+* // returns ~-0.767
 *
 * y = logcdf( 0.3 );
-* // returns ~-1.142
+* // returns ~-1.143
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/lib/index.js
@@ -38,10 +38,10 @@
 * var logpdf = factory( 0.5, 0.5 );
 *
 * var y = logpdf( 0.8 );
-* // returns ~-0.228
+* // returns ~-1.621
 *
 * y = logpdf( 0.3 );
-* // returns ~-0.364
+* // returns ~-0.805
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/lib/index.js
@@ -38,7 +38,7 @@
 * var quantile = factory( 2.0, 2.0 );
 *
 * var y = quantile( 0.8 );
-* // returns ~2.482
+* // returns ~2.483
 *
 * y = quantile( 0.4 );
 * // returns ~0.763
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/cdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/cdf/lib/index.js
@@ -36,7 +36,7 @@
 * // returns ~0.834
 *
 * y = cdf( 0.0, 10, 0.4 );
-* // returns ~0.06
+* // returns ~0.006
 *
 * @example
 * var factory = require( '@stdlib/stats/base/dists/binomial/cdf' ).factory;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/entropy/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/entropy/lib/index.js
@@ -27,10 +27,10 @@
 * var entropy = require( '@stdlib/stats/base/dists/binomial/entropy' );
 *
 * var v = entropy( 100, 0.1 );
-* // returns ~0.051
+* // returns ~2.511
 *
 * v = entropy( 20, 0.5 );
-* // returns ~-0.1
+* // returns ~2.223
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/logpmf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/logpmf/lib/index.js
@@ -44,7 +44,7 @@
 * var logpmf = factory( 10, 0.5 );
 *
 * var y = logpmf( 3.0 );
-* // returns ~-2.146
+* // returns ~-2.144
 *
 * y = logpmf( 5.0 );
 * // returns ~-1.402
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/quantile/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/quantile/lib/index.js
@@ -27,7 +27,7 @@
 * var quantile = require( '@stdlib/stats/base/dists/binomial/quantile' );
 *
 * var y = quantile( 0.4, 20, 0.2 );
-* // returns 2
+* // returns 3
 *
 * y = quantile( 0.8, 20, 0.2 );
 * // returns 5
diff --git a/lib/node_modules/@stdlib/stats/base/dists/binomial/skewness/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/binomial/skewness/lib/index.js
@@ -27,10 +27,10 @@
 * var skewness = require( '@stdlib/stats/base/dists/binomial/skewness' );
 *
 * var v = skewness( 100, 0.1 );
-* // returns 9
+* // returns ~0.267
 *
 * v = skewness( 20, 0.5 );
-* // returns 5
+* // returns 0
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/chi/logpdf/lib/index.js
@@ -35,7 +35,7 @@
 * var logpdf = factory( 6.0 );
 *
 * var y = logpdf( 3.0 );
-* // returns ~-1.088
+* // returns ~-1.086
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/quantile/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/chi/quantile/lib/index.js
@@ -32,7 +32,7 @@
 * var myquantile = quantile.factory( 2.0 );
 *
 * y = myquantile( 0.3 );
-* // returns ~0.844
+* // returns ~0.845
 *
 * y = myquantile( 0.7 );
 * // returns ~1.552
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/lib/index.js
@@ -32,7 +32,7 @@
 * var mylogcdf = logcdf.factory( 3.0, 1.5 );
 *
 * y = mylogcdf( 4.0 );
-* // returns ~--0.029
+* // returns ~-0.029
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/index.js
@@ -26,8 +26,8 @@
 * @example
 * var logpdf = require( '@stdlib/stats/base/dists/cosine/logpdf' );
 *
-* var y = logpdf( 2.0, 0.0, 1.0 );
-* // returns ~-2.254
+* var y = logpdf( 2.0, 0.0, 3.0 );
+* // returns ~-2.485
 *
 * var mylogpdf = logpdf.factory( 10.0, 2.0 );
 * y = mylogpdf( 10.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/erlang/entropy/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/erlang/entropy/lib/index.js
@@ -27,13 +27,13 @@
 * var entropy = require( '@stdlib/stats/base/dists/erlang/entropy' );
 *
 * var v = entropy( 1, 1.0 );
-* // returns ~-0.154
+* // returns 1
 *
 * v = entropy( 4, 12.0 );
-* // returns ~9.587
+* // returns ~-0.462
 *
 * v = entropy( 8, 2.0 );
-* // returns ~33.973
+* // returns ~1.723
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/lib/index.js
@@ -31,7 +31,7 @@
 *
 * var myLogPDF = logpdf.factory( 6, 7.0 );
 * y = myLogPDF( 7.0 );
-* // returns ~-1.864
+* // returns ~-32.382
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/erlang/pdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/erlang/pdf/lib/index.js
@@ -31,7 +31,7 @@
 *
 * var myPDF = pdf.factory( 6, 7.0 );
 * y = myPDF( 7.0 );
-* // returns ~0.155
+* // returns ~8.64e-15
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/stdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/stdev/lib/index.js
@@ -27,10 +27,10 @@
 * var stdev = require( '@stdlib/stats/base/dists/exponential/stdev' );
 *
 * var v = stdev( 11.0 );
-* // returns ~0.089
+* // returns ~0.091
 *
 * v = stdev( 4.5 );
-* // returns ~0.221
+* // returns ~0.222
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/mgf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/mgf/lib/index.js
@@ -38,7 +38,7 @@
 * var mymgf = mgf.factory( 3.0, 1.5 );
 *
 * y = mymgf( 1.0 );
-* // returns ~26.999
+* // returns ~27.0
 *
 * y = mymgf( 0.5 );
 * // returns ~3.375
diff --git a/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/logpmf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/hypergeometric/logpmf/lib/index.js
@@ -43,7 +43,7 @@
 * // returns ~-1.079
 *
 * y = mylogpmf( 1.0 );
-* // returns ~-3.54
+* // returns ~-3.524
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logcdf/lib/index.js
@@ -41,7 +41,7 @@
 * // returns ~-0.393
 *
 * y = logcdf( 0.3 );
-* // returns ~-1.118
+* // returns ~-1.116
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logpdf/lib/index.js
@@ -41,7 +41,7 @@
 * // returns ~-0.151
 *
 * y = logpdf( 0.3 );
-* // returns ~-0.387
+* // returns ~-0.388
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/stdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/stdev/lib/index.js
@@ -27,13 +27,13 @@
 * var stdev = require( '@stdlib/stats/base/dists/kumaraswamy/stdev' );
 *
 * var v = stdev( 2.0, 1.0 );
-* // returns ~0.237
+* // returns ~0.236
 *
 * v = stdev( 4.0, 12.0 );
 * // returns ~0.13
 *
 * v = stdev( 16.0, 8.0 );
-* // returns ~0.063
+* // returns ~0.062
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/index.js
@@ -34,7 +34,7 @@
 *
 * var mylogcdf = logcdf.factory( 2.0, 3.0 );
 * y = mylogcdf( 10.0 );
-* // returns ~-0.036
+* // returns ~-0.035
 *
 * y = mylogcdf( 2.0 );
 * // returns ~-0.693
diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/index.js
@@ -27,11 +27,11 @@
 * var logpdf = require( '@stdlib/stats/base/dists/laplace/logpdf' );
 *
 * var y = logpdf( 2.0, 0.0, 1.0 );
-* // returns ~-2.688
+* // returns ~-2.693
 *
 * var mylogPDF = logpdf.factory( 10.0, 2.0 );
 * y = mylogPDF( 10.0 );
-* // returns -1.386
+* // returns ~-1.386
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/index.js
@@ -30,7 +30,7 @@
 * // returns ~-0.538
 *
 * y = logcdf( 0.3, 0.0, 3.0 );
-* // returns ~-6.215
+* // returns ~-6.460
 *
 * @example
 * var factory = require( '@stdlib/stats/base/dists/levy/logcdf' ).factory;

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@`
`44`	`44`	`* var mgf = factory( 0.5, 0.5 );`
`45`	`45`	`*`
`46`	`46`	`* var y = mgf( 0.8 );`
`47`		`-* // returns ~1.522`
	`47`	`+* // returns ~1.552`
`48`	`48`	`*`
`49`	`49`	`* y = mgf( 0.3 );`
`50`	`50`	`* // returns ~1.168`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`* // returns ~0.713`
`42`	`42`	`*`
`43`	`43`	`* y = quantile( 0.4 );`
`44`		`-* // returns ~0.5`
	`44`	`+* // returns ~0.433`
`45`	`45`	`*/`
`46`	`46`
`47`	`47`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`* // returns ~0.529`
`34`	`34`	`*`
`35`	`35`	`* v = skewness( 8.0, 2.0 );`
`36`		`-* // returns ~0.829`
	`36`	`+* // returns ~-0.829`
`37`	`37`	`*/`
`38`	`38`
`39`	`39`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -38,10 +38,10 @@`
`38`	`38`	`* var logcdf = factory( 0.5, 0.5 );`
`39`	`39`	`*`
`40`	`40`	`* var y = logcdf( 0.8 );`
`41`		`-* // returns ~-0.766`
	`41`	`+* // returns ~-0.767`
`42`	`42`	`*`
`43`	`43`	`* y = logcdf( 0.3 );`
`44`		`-* // returns ~-1.142`
	`44`	`+* // returns ~-1.143`
`45`	`45`	`*/`
`46`	`46`
`47`	`47`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`* var quantile = factory( 2.0, 2.0 );`
`39`	`39`	`*`
`40`	`40`	`* var y = quantile( 0.8 );`
`41`		`-* // returns ~2.482`
	`41`	`+* // returns ~2.483`
`42`	`42`	`*`
`43`	`43`	`* y = quantile( 0.4 );`
`44`	`44`	`* // returns ~0.763`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`* // returns ~0.834`
`37`	`37`	`*`
`38`	`38`	`* y = cdf( 0.0, 10, 0.4 );`
`39`		`-* // returns ~0.06`
	`39`	`+* // returns ~0.006`
`40`	`40`	`*`
`41`	`41`	`* @example`
`42`	`42`	`* var factory = require( '@stdlib/stats/base/dists/binomial/cdf' ).factory;`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,10 @@`
`27`	`27`	`* var entropy = require( '@stdlib/stats/base/dists/binomial/entropy' );`
`28`	`28`	`*`
`29`	`29`	`* var v = entropy( 100, 0.1 );`
`30`		`-* // returns ~0.051`
	`30`	`+* // returns ~2.511`
`31`	`31`	`*`
`32`	`32`	`* v = entropy( 20, 0.5 );`
`33`		`-* // returns ~-0.1`
	`33`	`+* // returns ~2.223`
`34`	`34`	`*/`
`35`	`35`
`36`	`36`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* var quantile = require( '@stdlib/stats/base/dists/binomial/quantile' );`
`28`	`28`	`*`
`29`	`29`	`* var y = quantile( 0.4, 20, 0.2 );`
`30`		`-* // returns 2`
	`30`	`+* // returns 3`
`31`	`31`	`*`
`32`	`32`	`* y = quantile( 0.8, 20, 0.2 );`
`33`	`33`	`* // returns 5`