From 8915d5f64d83a5541b3aeead3486d19c40b618c0 Mon Sep 17 00:00:00 2001 From: officiallyanee Date: Sat, 3 Oct 2026 04:54:56 +0530 Subject: [PATCH] docs: fix incorrect return annotations for negative zero --- 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: skipped - task: lint_markdown_pkg_readmes status: passed - task: lint_markdown_docs status: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/dists/beta/logpdf/README.md | 2 +- .../@stdlib/stats/base/dists/beta/logpdf/lib/index.js | 2 +- .../@stdlib/stats/base/dists/beta/logpdf/lib/main.js | 2 +- .../@stdlib/stats/base/dists/pareto-type1/logcdf/README.md | 2 +- .../@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js | 2 +- .../@stdlib/stats/base/dists/pareto-type1/logcdf/lib/main.js | 2 +- .../@stdlib/stats/base/dists/uniform/logpdf/README.md | 4 ++-- .../@stdlib/stats/base/dists/uniform/logpdf/lib/index.js | 2 +- .../@stdlib/stats/base/dists/uniform/logpdf/lib/main.js | 2 +- .../@stdlib/stats/base/dists/weibull/logcdf/README.md | 2 +- .../@stdlib/stats/base/dists/weibull/logcdf/lib/main.js | 2 +- 11 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/README.md index 2320e49e4d27..fb19196d0040 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/README.md @@ -62,7 +62,7 @@ var y = logpdf( 0.5, 0.5, 1.0 ); // returns ~-0.347 y = logpdf( 0.1, 1.0, 1.0 ); -// returns 0.0 +// returns -0.0 y = logpdf( 0.8, 4.0, 2.0 ); // returns ~0.717 diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/index.js index e2239386efa9..56cf3e4abaf5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/index.js @@ -27,7 +27,7 @@ * var logpdf = require( '@stdlib/stats/base/dists/beta/logpdf' ); * * var y = logpdf( 0.5, 1.0, 1.0 ); -* // returns 0.0 +* // returns -0.0 * * y = logpdf( 0.5, 2.0, 4.0 ); * // returns ~0.223 diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/main.js index 0ac3fa91e48e..9e11956bcd5b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/beta/logpdf/lib/main.js @@ -40,7 +40,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); * * @example * var y = logpdf( 0.5, 1.0, 1.0 ); -* // returns 0.0 +* // returns -0.0 * * @example * var y = logpdf( 0.5, 2.0, 4.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md index 927c247fb507..c6ffbb2a242b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md @@ -71,7 +71,7 @@ y = logcdf( 1.9, 2.0, 2.0 ); // returns -Infinity y = logcdf( +Infinity, 4.0, 2.0 ); -// returns 0.0 +// returns -0.0 ``` If provided `NaN` as any argument, the function returns `NaN`. 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 index 4a92d2863e86..177641b60074 100644 --- 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 @@ -39,7 +39,7 @@ * // returns -Infinity * * y = logcdf( +Infinity, 4.0, 2.0 ); -* // returns 0.0 +* // returns -0.0 * * var mylogcdf = logcdf.factory( 10.0, 2.0 ); * y = mylogcdf( 3.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/main.js index 463b2197f079..1d57226284ac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/main.js @@ -54,7 +54,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); * * @example * var y = logcdf( +Infinity, 4.0, 2.0 ); -* // returns 0.0 +* // returns -0.0 * * @example * var y = logcdf( 2.0, -1.0, 0.5 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md index 4021e818264f..09c87e0108e2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md @@ -65,7 +65,7 @@ y = logpdf( 5.0, 0.0, 4.0 ); // returns -Infinity y = logpdf( 0.25, 0.0, 1.0 ); -// returns 0.0 +// returns -0.0 ``` If provided `NaN` as any argument, the function returns `NaN`. @@ -98,7 +98,7 @@ Returns a `function` for evaluating the logarithm of the [PDF][pdf] of a [contin ```javascript var mylogPDF = logpdf.factory( 6.0, 7.0 ); var y = mylogPDF( 7.0 ); -// returns 0.0 +// returns -0.0 y = mylogPDF( 5.0 ); // returns -Infinity diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js index a351daf258d8..82e139b04653 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js @@ -31,7 +31,7 @@ * * var mylogPDF = logpdf.factory( 6.0, 7.0 ); * y = mylogPDF( 7.0 ); -* // returns 0.0 +* // returns -0.0 * * y = mylogPDF( 5.0 ); * // returns -Infinity diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js index c9b4238b3b35..32f0f4710324 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js @@ -45,7 +45,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); * * @example * var y = logpdf( 0.25, 0.0, 1.0 ); -* // returns 0.0 +* // returns -0.0 * * @example * var y = logpdf( NaN, 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md index 0640bbc462a0..b38bbe8faeeb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md @@ -68,7 +68,7 @@ y = logcdf( -Infinity, 4.0, 2.0 ); // returns -Infinity y = logcdf( +Infinity, 4.0, 2.0 ); -// returns 0.0 +// returns -0.0 ``` If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/main.js index 6d48caf56e39..bb81cf247151 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/main.js @@ -50,7 +50,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); * * @example * var y = logcdf( +Infinity, 4.0, 2.0 ); -* // returns 0.0 +* // returns -0.0 * * @example * var y = logcdf( -Infinity, 4.0, 2.0 );