Skip to content

Commit 23b1985

Browse files
committed
docs: clarify descriptions
--- 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: 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent b8f5542 commit 23b1985

File tree

1 file changed

+2
-2
lines changed
  • lib/node_modules/@stdlib/stats/base/variancetk

1 file changed

+2
-2
lines changed

lib/node_modules/@stdlib/stats/base/variancetk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ var variancetk = require( '@stdlib/stats/base/variancetk' );
100100

101101
#### variancetk( N, correction, x, strideX )
102102

103-
Computes the [variance][variance] of a strided array `x` using a one-pass textbook algorithm.
103+
Computes the [variance][variance] of a strided array using a one-pass textbook algorithm.
104104

105105
```javascript
106106
var x = [ 1.0, -2.0, 2.0 ];
@@ -154,7 +154,7 @@ The function has the following additional parameters:
154154

155155
- **offsetX**: starting index for `x`.
156156

157-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [variance][variance] for every element value in the strided array starting from the second element
157+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [variance][variance] for every other element in the strided array starting from the second element
158158

159159
```javascript
160160
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];

0 commit comments

Comments
 (0)