Skip to content

Commit 94f8217

Browse files
committed
docs: update docs
--- 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: passed - task: lint_license_headers status: passed ---
1 parent cbf06fc commit 94f8217

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
{{alias}}( N, correction, x, stride )
2+
{{alias}}( N, correction, x, strideX )
33
Computes the variance of a strided array using a two-pass algorithm.
44

55
The `N` and stride parameters determine which elements in the strided array
@@ -30,7 +30,7 @@
3030
x: Array<number>|TypedArray
3131
Input array.
3232

33-
stride: integer
33+
strideX: integer
3434
Stride length.
3535

3636
Returns
@@ -57,7 +57,7 @@
5757
~4.3333
5858

5959

60-
{{alias}}.ndarray( N, correction, x, stride, offset )
60+
{{alias}}.ndarray( N, correction, x, strideX, offsetX )
6161
Computes the variance of a strided array using a two-pass algorithm and
6262
alternative indexing semantics.
6363

@@ -85,10 +85,10 @@
8585
x: Array<number>|TypedArray
8686
Input array.
8787

88-
stride: integer
88+
strideX: integer
8989
Stride length.
9090

91-
offset: integer
91+
offsetX: integer
9292
Starting index.
9393

9494
Returns

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2025 The Stdlib Authors.
4+
* Copyright (c) 2020 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -27,7 +27,6 @@ import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array
2727
*/
2828
type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
2929

30-
3130
/**
3231
* Interface describing `variancepn`.
3332
*/

lib/node_modules/@stdlib/stats/base/variancepn/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2025 The Stdlib Authors.
4+
* Copyright (c) 2020 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)