Skip to content

Commit 336127f

Browse files
committed
docs: fix grammar
--- 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: passed - task: lint_javascript_src status: passed - 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: passed - task: lint_license_headers status: passed ---
1 parent 86fc63f commit 336127f

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

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

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

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

103-
Computes the [standard deviation][standard-deviation] of a strided array `x` ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer.
103+
Computes the [standard deviation][standard-deviation] of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer.
104104

105105
```javascript
106106
var x = [ 1.0, -2.0, NaN, 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 parameters support indexing semantics based on a starting indices. For example, to calculate the [standard deviation][standard-deviation] for every other value in `x` starting from the second value
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 [standard deviation][standard-deviation] for every other element in `x` 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 ];

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Computes the standard deviation of a strided array ignoring `NaN` values and
44
using a one-pass algorithm proposed by Youngs and Cramer.
55

6-
The `N` and stride parameters determine which elements in the strided arrays
6+
The `N` and stride parameters determine which elements in the strided array
77
are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use a typed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import nanstdevyc = require( './index' );
2626
{
2727
const x = new Float64Array( 10 );
2828

29+
nanstdevyc( x.length, 1, x, 1 ); // $ExpectType number
2930
nanstdevyc( x.length, 1, new AccessorArray( x ), 1 ); // $ExpectType number
3031
}
3132

@@ -101,6 +102,7 @@ import nanstdevyc = require( './index' );
101102
{
102103
const x = new Float64Array( 10 );
103104

105+
nanstdevyc.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType number
104106
nanstdevyc.ndarray( x.length, 1, new AccessorArray( x ), 1, 0 ); // $ExpectType number
105107
}
106108

lib/node_modules/@stdlib/stats/base/nanstdevyc/lib/index.js

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,15 @@
2828
*
2929
* var x = [ 1.0, -2.0, NaN, 2.0 ];
3030
*
31-
* var v = nanstdevyc( x.length, 1, x, 1 );
31+
* var v = nanstdevyc( 4, 1, x, 1 );
3232
* // returns ~2.0817
3333
*
3434
* @example
35-
* var floor = require( '@stdlib/math/base/special/floor' );
3635
* var nanstdevyc = require( '@stdlib/stats/base/nanstdevyc' );
3736
*
3837
* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];
39-
* var N = floor( x.length / 2 );
4038
*
41-
* var v = nanstdevyc.ndarray( N, 1, x, 2, 1 );
39+
* var v = nanstdevyc.ndarray( 5, 1, x, 2, 1 );
4240
* // returns 2.5
4341
*/
4442

lib/node_modules/@stdlib/stats/base/nanstdevyc/lib/nanstdevyc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ var ndarray = require( './ndarray.js' );
3838
* @example
3939
* var x = [ 1.0, -2.0, NaN, 2.0 ];
4040
*
41-
* var v = nanstdevyc( x.length, 1, x, 1 );
41+
* var v = nanstdevyc( 4, 1, x, 1 );
4242
* // returns ~2.0817
4343
*/
4444
function nanstdevyc( N, correction, x, strideX ) {

0 commit comments

Comments
 (0)