Skip to content

Commit cec76df

Browse files
committed
docs: fix examples
--- 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: passed - task: lint_package_json status: na - task: lint_repl_help status: skipped - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 1ce2a18 commit cec76df

File tree

1 file changed

+5
-3
lines changed
  • lib/node_modules/@stdlib/stats/strided/dztest

1 file changed

+5
-3
lines changed

lib/node_modules/@stdlib/stats/strided/dztest/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,16 @@ The function has the following parameters:
7171

7272
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to perform a one-sample Z-test over every other element in `x`,
7373

74+
<!-- eslint-disable max-len -->
75+
7476
```javascript
7577
var Float64Array = require( '@stdlib/array/float64' );
7678
var Results = require( '@stdlib/stats/base/ztest/one-sample/results/float64' );
7779

7880
var x = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0, 0.0 ] );
7981

8082
var results = new Results();
81-
var out = dztest( x.length, 'two-sided', 0.05, 0.0, 1.0, x, 2, results );
83+
var out = dztest( 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, results );
8284
// returns {...}
8385

8486
var bool = ( out === results );
@@ -97,7 +99,7 @@ var x0 = new Float64Array( [ 0.0, 4.0, 4.0, 6.0, 6.0, 5.0 ] );
9799
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
98100

99101
var results = new Results();
100-
var out = dztest( x.length, 'two-sided', 0.05, 0.0, 1.0, x1, 1, results );
102+
var out = dztest( x1.length, 'two-sided', 0.05, 0.0, 1.0, x1, 1, results );
101103
// returns {...}
102104

103105
var bool = ( out === results );
@@ -135,7 +137,7 @@ var Results = require( '@stdlib/stats/base/ztest/one-sample/results/float64' );
135137
var x = new Float64Array( [ 0.0, 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0 ] );
136138

137139
var results = new Results();
138-
var out = dztest.ndarray( x.length, 'two-sided', 0.05, 0.0, 1.0, x, 2, 1, results );
140+
var out = dztest.ndarray( 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, 1, results );
139141
// returns {...}
140142

141143
var bool = ( out === results );

0 commit comments

Comments
 (0)