Skip to content

Commit 2cabe18

Browse files
committed
docs: fix return values in TSDoc return annotation comments
--- 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: 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent e02e358 commit 2cabe18

File tree

18 files changed

+31
-31
lines changed

18 files changed

+31
-31
lines changed

lib/node_modules/@stdlib/stats/base/dists/beta/mgf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ interface MGF {
131131
* var myMGF = mgf.factory( 0.5, 0.5 );
132132
*
133133
* y = myMGF( 0.8 );
134-
* // returns ~1.522
134+
* // returns ~1.552
135135
*
136136
* y = myMGF( 0.3 );
137137
* // returns ~1.168

lib/node_modules/@stdlib/stats/base/dists/betaprime/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,10 @@ interface Namespace {
130130
* var mylogcdf = ns.logcdf.factory( 0.5, 0.5 );
131131
*
132132
* var y = mylogcdf( 0.8 );
133-
* // returns ~-0.766
133+
* // returns ~-0.767
134134
*
135135
* y = mylogcdf( 0.3 );
136-
* // returns ~-1.142
136+
* // returns ~-1.143
137137
*/
138138
logcdf: typeof logcdf;
139139

@@ -155,10 +155,10 @@ interface Namespace {
155155
* var mylogpdf = ns.logpdf.factory( 0.5, 0.5 );
156156
*
157157
* var y = mylogpdf( 0.8 );
158-
* // returns ~-0.228
158+
* // returns ~-1.62
159159
*
160160
* y = mylogpdf( 0.3 );
161-
* // returns ~-0.364
161+
* // returns ~-0.805
162162
*/
163163
logpdf: typeof logpdf;
164164

@@ -295,7 +295,7 @@ interface Namespace {
295295
* var myQuantile = ns.quantile.factory( 2.0, 2.0 );
296296
*
297297
* var y = myQuantile( 0.8 );
298-
* // returns ~2.482
298+
* // returns ~2.483
299299
*
300300
* y = myQuantile( 0.4 );
301301
* // returns ~0.763

lib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,10 @@ interface LogPDF {
121121
* var mylogpdf = logpdf.factory( 0.5, 0.5 );
122122
*
123123
* var y = mylogpdf( 0.8 );
124-
* // returns ~-0.228
124+
* // returns ~-1.62
125125
*
126126
* y = mylogpdf( 0.3 );
127-
* // returns ~-0.364
127+
* // returns ~-0.805
128128
*/
129129
declare var logpdf: LogPDF;
130130

lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ interface Quantile {
121121
* var myQuantile = quantile.factory( 2.0, 2.0 );
122122
*
123123
* var y = myQuantile( 0.8 );
124-
* // returns ~2.482
124+
* // returns ~2.483
125125
*
126126
* y = myQuantile( 0.4 );
127127
* // returns ~0.763

lib/node_modules/@stdlib/stats/base/dists/binomial/cdf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ interface CDF {
126126
* // returns ~0.834
127127
*
128128
* y = cdf( 0.0, 10, 0.4 );
129-
* // returns ~0.06
129+
* // returns ~0.006
130130
*
131131
* var mycdf = cdf.factory( 10, 0.5 );
132132
*

lib/node_modules/@stdlib/stats/base/dists/binomial/ctor/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ declare class Binomial {
5151
* var binomial = new Binomial();
5252
*
5353
* var y = binomial.cdf( 0.8 );
54-
* // returns ~0.9
54+
* // returns 0.5
5555
*
5656
* var v = binomial.mode;
57-
* // returns 0.0
57+
* // returns 1.0
5858
*/
5959
constructor();
6060

lib/node_modules/@stdlib/stats/base/dists/binomial/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ interface Namespace {
5858
* // returns ~0.834
5959
*
6060
* y = ns.cdf( 0.0, 10, 0.4 );
61-
* // returns ~0.06
61+
* // returns ~0.006
6262
*
6363
* var mycdf = ns.cdf.factory( 10, 0.5 );
6464
*
@@ -167,7 +167,7 @@ interface Namespace {
167167
* var mylogpmf = ns.logpmf.factory( 10, 0.5 );
168168
*
169169
* y = mylogpmf( 3.0 );
170-
* // returns ~-2.146
170+
* // returns ~-2.144
171171
*
172172
* y = mylogpmf( 5.0 );
173173
* // returns ~-1.402
@@ -320,7 +320,7 @@ interface Namespace {
320320
* // returns ~0.201
321321
*
322322
* y = ns.pmf( 0.0, 10, 0.4 );
323-
* // returns ~0.06
323+
* // returns ~0.006
324324
*
325325
* var mypmf = ns.pmf.factory( 10, 0.5 );
326326
*
@@ -342,7 +342,7 @@ interface Namespace {
342342
*
343343
* @example
344344
* var y = ns.quantile( 0.4, 20, 0.2 );
345-
* // returns 2
345+
* // returns 3
346346
*
347347
* y = ns.quantile( 0.8, 20, 0.2 );
348348
* // returns 5

lib/node_modules/@stdlib/stats/base/dists/binomial/logpmf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ interface LogPMF {
131131
* var mylogpmf = logpmf.factory( 10, 0.5 );
132132
*
133133
* y = mylogpmf( 3.0 );
134-
* // returns ~-2.146
134+
* // returns ~-2.144
135135
*
136136
* y = mylogpmf( 5.0 );
137137
* // returns ~-1.402

lib/node_modules/@stdlib/stats/base/dists/binomial/pmf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ interface PMF {
126126
* // returns ~0.201
127127
*
128128
* y = pmf( 0.0, 10, 0.4 );
129-
* // returns ~0.06
129+
* // returns ~0.006
130130
*
131131
* var mypmf = pmf.factory( 10, 0.5 );
132132
*

lib/node_modules/@stdlib/stats/base/dists/binomial/quantile/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ interface Quantile {
126126
*
127127
* @example
128128
* var y = quantile( 0.4, 20, 0.2 );
129-
* // returns 2
129+
* // returns 3
130130
*
131131
* y = quantile( 0.8, 20, 0.2 );
132132
* // returns 5

0 commit comments

Comments
 (0)