Skip to content

Commit fd036a7

Browse files
committed
docs: update parameter name in stdevpn documentation for clarity
--- 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 a039378 commit fd036a7

File tree

1 file changed

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

1 file changed

+2
-4
lines changed

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ The use of the term `n-1` is commonly referred to as Bessel's correction. Note,
9898
var stdevpn = require( '@stdlib/stats/base/stdevpn' );
9999
```
100100

101-
#### stdevpn( N, correction, x, stride )
101+
#### stdevpn( N, correction, x, strideX )
102102

103-
Computes the [standard deviation][standard-deviation] of a strided array `x` using a two-pass algorithm.
103+
Computes the [standard deviation][standard-deviation] of a strided array using a two-pass algorithm.
104104

105105
```javascript
106106
var x = [ 1.0, -2.0, 2.0 ];
@@ -119,8 +119,6 @@ The function has the following parameters:
119119
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [standard deviation][standard-deviation] of every other element in `x`,
120120

121121
```javascript
122-
var floor = require( '@stdlib/math/base/special/floor' );
123-
124122
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
125123

126124
var v = stdevpn( 4, 1, x, 2 );

0 commit comments

Comments
 (0)