Skip to content

Commit 5357283

Browse files
committed
docs: update examples and parameter types in variancetk documentation
--- 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: passed - 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: na - task: lint_license_headers status: passed ---
1 parent 23b1985 commit 5357283

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

lib/node_modules/@stdlib/stats/base/variancetk/docs/repl.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@
5454
// Using view offsets:
5555
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
5656
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
57-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
58-
> stride = 2;
5957
> {{alias}}( 3, 1, x1, 2 )
6058
~4.3333
6159

@@ -107,7 +105,7 @@
107105
~4.3333
108106

109107
// Using offset parameter:
110-
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];
108+
> x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];
111109
> {{alias}}.ndarray( 3, 1, x, 2, 1 )
112110
~4.3333
113111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ interface Routine {
6464
* var v = variancetk.ndarray( x.length, 1, x, 1, 0 );
6565
* // returns ~4.3333
6666
*/
67-
ndarray( N: number, correction: number, x: NumericArray, stride: number, offset: number ): number;
67+
ndarray( N: number, correction: number, x: InputArray, strideX: number, offsetX: number ): number;
6868
}
6969

7070
/**

0 commit comments

Comments
 (0)