Skip to content

Commit e02e358

Browse files
committed
docs: fix example code in TSDoc 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 e62f498 commit e02e358

File tree

9 files changed

+23
-23
lines changed

9 files changed

+23
-23
lines changed

lib/node_modules/@stdlib/stats/bartlett-test/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ interface Results {
9999
* 'b', 'b', 'b', 'b',
100100
* 'c', 'c', 'c', 'c', 'c'
101101
* ];
102-
* varout = bartlettTest( arr, {
102+
* var out = bartlettTest( arr, {
103103
* 'groups': groups
104104
* });
105105
* // returns {...}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ interface Routine {
9595
* // y => [ 1.0, 2.0, 2.0 ]
9696
*
9797
* @example
98-
* var x = [ 1.0, -2.0, 2.0 ] );
98+
* var x = [ 1.0, -2.0, 2.0 ];
9999
* var y = [ 0.0, 0.0, 0.0 ];
100100
*
101101
* cumaxabs.ndarray( x.length, x, 1, 0, y, 1, 0 );

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ interface PMF {
7575
* @returns PMF
7676
*
7777
* @example
78-
* var pmf = factory( 0.5 );
79-
* var y = pmf( 3.0 );
80-
* // returns ~0.0879
78+
* var mypmf = pmf.factory( 0.5 );
79+
* var y = mypmf( 3.0 );
80+
* // returns ~0.0878
8181
*
82-
* y = pmf( 1.0 );
83-
* // returns ~0.2386
82+
* y = mypmf( 1.0 );
83+
* // returns ~0.239
8484
*/
8585
factory( lambda: number ): Unary;
8686
}

lib/node_modules/@stdlib/stats/base/dists/truncated-normal/pdf/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,22 +72,22 @@ interface PDF {
7272
* @returns PDF
7373
*
7474
* @example
75-
* var myPDF = factory( 0.0, 1.0, 0.0, 1.0 );
75+
* var myPDF = pdf.factory( 0.0, 1.0, 0.0, 1.0 );
7676
* var y = myPDF( 0.8 );
7777
* // returns ~0.849
7878
*
7979
* @example
80-
* var myPDF = factory( 0.0, 1.0, 0.5, 1.0 );
80+
* var myPDF = pdf.factory( 0.0, 1.0, 0.5, 1.0 );
8181
* var y = myPDF( 0.8 );
8282
* // returns ~0.996
8383
*
8484
* @example
85-
* var myPDF = factory( 0.0, 1.0, 0.0, 1.0 );
85+
* var myPDF = pdf.factory( 0.0, 1.0, 0.0, 1.0 );
8686
* var y = myPDF( 2.0 );
8787
* // returns 0.0
8888
*
8989
* @example
90-
* var myPDF = factory( 0.0, 1.0, 0.0, 1.0 );
90+
* var myPDF = pdf.factory( 0.0, 1.0, 0.0, 1.0 );
9191
* var y = myPDF( -1.0 );
9292
* // returns 0.0
9393
*/
@@ -110,7 +110,7 @@ interface PDF {
110110
*
111111
* var mypdf = pdf.factory( -1.0, 1.0, 0.0, 1.0 );
112112
* y = mypdf( 0.9 );
113-
* // returns ~0.5896
113+
* // returns ~0.3898
114114
*/
115115
declare var pdf: PDF;
116116

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ interface Namespace {
7575
* // y => [ 1.0, 1.0, 2.0 ]
7676
*
7777
* @example
78-
* var x = [ 1.0, -2.0, 2.0 ] );
78+
* var x = [ 1.0, -2.0, 2.0 ];
7979
* var y = [ 0.0, 0.0, 0.0 ];
8080
*
8181
* ns.cumax.ndarray( x.length, x, 1, 0, y, 1, 0 );
@@ -101,7 +101,7 @@ interface Namespace {
101101
* // y => [ 1.0, 2.0, 2.0 ]
102102
*
103103
* @example
104-
* var x = [ 1.0, -2.0, 2.0 ] );
104+
* var x = [ 1.0, -2.0, 2.0 ];
105105
* var y = [ 0.0, 0.0, 0.0 ];
106106
*
107107
* ns.cumaxabs.ndarray( x.length, x, 1, 0, y, 1, 0 );
@@ -124,14 +124,14 @@ interface Namespace {
124124
* var y = [ 0.0, 0.0, 0.0 ];
125125
*
126126
* ns.cumin( x.length, x, 1, y, 1 );
127-
* // y => [ 1.0, 1.0, 2.0 ]
127+
* // y => [ 1.0, -2.0, -2.0 ]
128128
*
129129
* @example
130-
* var x = [ 1.0, -2.0, 2.0 ] );
130+
* var x = [ 1.0, -2.0, 2.0 ];
131131
* var y = [ 0.0, 0.0, 0.0 ];
132132
*
133133
* ns.cumin.ndarray( x.length, x, 1, 0, y, 1, 0 );
134-
* // y => [ 1.0, 1.0, 2.0 ]
134+
* // y => [ 1.0, -2.0, -2.0 ]
135135
*/
136136
cumin: typeof cumin;
137137

@@ -153,7 +153,7 @@ interface Namespace {
153153
* // y => [ 1.0, 1.0, 1.0 ]
154154
*
155155
* @example
156-
* var x = [ 1.0, -2.0, 2.0 ] );
156+
* var x = [ 1.0, -2.0, 2.0 ];
157157
* var y = [ 0.0, 0.0, 0.0 ];
158158
*
159159
* ns.cuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 );

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ interface Results {
8989
* 'method': 'One-sample Z-test'
9090
* };
9191
*
92-
* var obj = toJSON( results );
92+
* var obj = res2json( results );
9393
* // returns {...}
9494
*/
9595
declare function res2json( results: Results ): Results;

lib/node_modules/@stdlib/stats/fligner-test/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ interface Results {
9999
* 'b', 'b', 'b', 'b',
100100
* 'c', 'c', 'c', 'c', 'c'
101101
* ];
102-
* varout = flignerTest( arr, {
102+
* var out = flignerTest( arr, {
103103
* 'groups': groups
104104
* });
105105
* // returns {...}

lib/node_modules/@stdlib/stats/kruskal-test/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ interface Results {
9999
* 'b', 'b', 'b', 'b',
100100
* 'c', 'c', 'c', 'c', 'c'
101101
* ];
102-
* varout = kruskalTest( arr, {
102+
* var out = kruskalTest( arr, {
103103
* 'groups': groups
104104
* });
105105
* // returns {...}

lib/node_modules/@stdlib/stats/strided/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5917,7 +5917,7 @@ interface Namespace {
59175917
* @returns results object
59185918
*
59195919
* @example
5920-
* var Results = require( '@stdlib/stats/base/ns.ztest/one-sample/results/float64' );
5920+
* var Results = require( '@stdlib/stats/base/ztest/one-sample/results/float64' );
59215921
*
59225922
* var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
59235923
*
@@ -5929,7 +5929,7 @@ interface Namespace {
59295929
* // returns true
59305930
*
59315931
* @example
5932-
* var Results = require( '@stdlib/stats/base/ns.ztest/one-sample/results/float64' );
5932+
* var Results = require( '@stdlib/stats/base/ztest/one-sample/results/float64' );
59335933
*
59345934
* var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
59355935
*

0 commit comments

Comments
 (0)