Skip to content

Commit 9b13062

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 2cabe18 commit 9b13062

File tree

20 files changed

+57
-69
lines changed

20 files changed

+57
-69
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ interface Namespace {
136136
* var mylogpdf = ns.logpdf.factory( 6.0 );
137137
*
138138
* y = mylogpdf( 3.0 );
139-
* // returns ~-1.088
139+
* // returns ~-1.086
140140
*/
141141
logpdf: typeof logpdf;
142142

@@ -228,7 +228,7 @@ interface Namespace {
228228
* var myquantile = ns.quantile.factory( 2.0 );
229229
*
230230
* var y = myquantile( 0.3 );
231-
* // returns ~0.844
231+
* // returns ~0.8446
232232
*
233233
* y = myquantile( 0.7 );
234234
* // returns ~1.552

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ interface Namespace {
111111
* var mylogcdf = ns.logcdf.factory( 3.0, 1.5 );
112112
*
113113
* y = mylogcdf( 4.0 );
114-
* // returns ~--0.029
114+
* // returns ~-0.029
115115
*/
116116
logcdf: typeof logcdf;
117117

@@ -125,7 +125,7 @@ interface Namespace {
125125
*
126126
* @example
127127
* var y = ns.logpdf( 2.0, 0.0, 1.0 );
128-
* // returns ~-2.254
128+
* // returns -Infinity
129129
*
130130
* var mylogpdf = ns.logpdf.factory( 10.0, 2.0 );
131131
* y = mylogpdf( 10.0 );

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ interface LogCDF {
102102
* var mylogcdf = logcdf.factory( 3.0, 1.5 );
103103
*
104104
* y = mylogcdf( 4.0 );
105-
* // returns ~--0.029
105+
* // returns ~-0.029
106106
*/
107107
declare var logcdf: LogCDF;
108108

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ interface LogPDF {
105105
*
106106
* @example
107107
* var y = logpdf( 2.0, 0.0, 1.0 );
108-
* // returns ~-2.254
108+
* // returns -Infinity
109109
*
110110
* var mylogpdf = logpdf.factory( 10.0, 2.0 );
111111
* y = mylogpdf( 10.0 );

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ interface Namespace {
173173
*
174174
* var myLogPDF = ns.logpdf.factory( 6, 7.0 );
175175
* y = myLogPDF( 7.0 );
176-
* // returns ~-1.864
176+
* // returns ~-32.38
177177
*/
178178
logpdf: typeof logpdf;
179179

@@ -304,8 +304,8 @@ interface Namespace {
304304
* // returns ~0.895
305305
*
306306
* var myPDF = ns.pdf.factory( 6, 7.0 );
307-
* y = myPDF( 7.0 );
308-
* // returns ~0.155
307+
* y = myPDF( 2.0 );
308+
* // returns ~0.026
309309
*/
310310
pdf: typeof pdf;
311311

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ interface MGF {
124124
* var mymgf = mgf.factory( 3.0, 1.5 );
125125
*
126126
* y = mymgf( 1.0 );
127-
* // returns ~26.999
127+
* // returns ~27.0
128128
*
129129
* y = mymgf( 0.5 );
130130
* // returns ~3.375

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

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ interface Namespace {
150150
* // returns ~-1.079
151151
*
152152
* y = mylogpmf( 1.0 );
153-
* // returns ~-3.54
153+
* // returns ~-3.524
154154
*/
155155
logpmf: typeof logpmf;
156156

@@ -266,30 +266,24 @@ interface Namespace {
266266
* @returns evaluated PMF
267267
*
268268
* @example
269-
* var y = ns.pmf( 5.0, 20.0, 0.8 );
270-
* // returns ~0.157
269+
* var y = ns.pmf( 1.0, 8, 4, 2 );
270+
* // returns ~0.571
271271
*
272-
* y = ns.pmf( 21.0, 20.0, 0.5 );
273-
* // returns ~0.06
274-
*
275-
* y = ns.pmf( 5.0, 10.0, 0.4 );
276-
* // returns ~0.016
277-
*
278-
* y = ns.pmf( 0.0, 10.0, 0.9 );
279-
* // returns ~0.349
272+
* y = ns.pmf( 2.0, 8, 4, 2 );
273+
* // returns ~0.214
280274
*
281-
* y = ns.pmf( 21.0, 15.5, 0.5 );
282-
* // returns ~0.037
275+
* y = ns.pmf( 0.0, 8, 4, 2 );
276+
* // returns ~0.214
283277
*
284-
* y = ns.pmf( 5.0, 7.4, 0.4 );
285-
* // returns ~0.051
278+
* y = ns.pmf( 1.5, 8, 4, 2 );
279+
* // returns 0.0
286280
*
287-
* var mypmf = ns.pmf.factory( 10, 0.5 );
288-
* y = mypmf( 3.0 );
289-
* // returns ~0.027
281+
* var mypmf = ns.pmf.factory( 30, 20, 5 );
282+
* y = mypmf( 4.0 );
283+
* // returns ~0.34
290284
*
291-
* y = mypmf( 5.0 );
292-
* // returns ~0.061
285+
* y = mypmf( 1.0 );
286+
* // returns ~0.029
293287
*/
294288
pmf: typeof pmf;
295289

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ interface LogPMF {
144144
* // returns ~-1.079
145145
*
146146
* y = mylogpmf( 1.0 );
147-
* // returns ~-3.54
147+
* // returns ~-3.524
148148
*/
149149
declare var logpmf: LogPMF;
150150

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

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -127,30 +127,24 @@ interface PMF {
127127
* @returns evaluated PMF
128128
*
129129
* @example
130-
* var y = pmf( 5.0, 20.0, 0.8 );
131-
* // returns ~0.157
130+
* var y = pmf( 1.0, 8, 4, 2 );
131+
* // returns ~0.571
132132
*
133-
* y = pmf( 21.0, 20.0, 0.5 );
134-
* // returns ~0.06
133+
* y = pmf( 2.0, 8, 4, 2 );
134+
* // returns ~0.214
135135
*
136-
* y = pmf( 5.0, 10.0, 0.4 );
137-
* // returns ~0.016
136+
* y = pmf( 0.0, 8, 4, 2 );
137+
* // returns ~0.214
138138
*
139-
* y = pmf( 0.0, 10.0, 0.9 );
140-
* // returns ~0.349
139+
* y = pmf( 1.5, 8, 4, 2 );
140+
* // returns 0.0
141141
*
142-
* y = pmf( 21.0, 15.5, 0.5 );
143-
* // returns ~0.037
142+
* var mypmf = pmf.factory( 30, 20, 5 );
143+
* y = mypmf( 4.0 );
144+
* // returns ~0.34
144145
*
145-
* y = pmf( 5.0, 7.4, 0.4 );
146-
* // returns ~0.051
147-
*
148-
* var mypmf = pmf.factory( 10, 0.5 );
149-
* y = mypmf( 3.0 );
150-
* // returns ~0.027
151-
*
152-
* y = mypmf( 5.0 );
153-
* // returns ~0.061
146+
* y = mypmf( 1.0 );
147+
* // returns ~0.029
154148
*/
155149
declare var pmf: PMF;
156150

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ interface Namespace {
130130
* // returns ~-0.393
131131
*
132132
* y = mylogcdf( 0.3 );
133-
* // returns ~-1.118
133+
* // returns ~-1.116
134134
*/
135135
logcdf: typeof logcdf;
136136

@@ -155,7 +155,7 @@ interface Namespace {
155155
* // returns ~-0.151
156156
*
157157
* y = mylogpdf( 0.3 );
158-
* // returns ~-0.387
158+
* // returns ~-0.388
159159
*/
160160
logpdf: typeof logpdf;
161161

@@ -326,7 +326,7 @@ interface Namespace {
326326
* y = ns.quantile( 0.5, 2.0, 4.0 );
327327
* // returns ~0.399
328328
*
329-
* var myQuantile = factory( 0.5, 0.5 );
329+
* var myQuantile = ns.quantile.factory( 0.5, 0.5 );
330330
*
331331
* y = myQuantile( 0.8 );
332332
* // returns ~0.922

0 commit comments

Comments
 (0)