Skip to content

Commit 0dbec03

Browse files
committed
docs: ensure consistent conventions
--- 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: na - task: lint_license_headers status: passed ---
1 parent 32e9189 commit 0dbec03

File tree

4 files changed

+10
-14
lines changed

4 files changed

+10
-14
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The function has the following parameters:
6868
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
6969
- **strideX**: stride length for `x`.
7070

71-
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`,
71+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`,
7272

7373
```javascript
7474
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ];
@@ -106,7 +106,7 @@ The function has the following additional parameters:
106106

107107
- **offsetX**: starting index for `x`.
108108

109-
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 index. For example, to calculate the [arithmetic mean][arithmetic-mean] for every other value in `x` starting from the second value
109+
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 [arithmetic mean][arithmetic-mean] for every other value in `x` starting from the second value
110110

111111
```javascript
112112
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@
3737
~0.3333
3838

3939
// Using `N` and stride parameters:
40-
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ];
41-
> {{alias}}( 3, x, 2 )
40+
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ];
41+
> {{alias}}( 4, x, 2 )
4242
~0.3333
4343

4444
// Using view offsets:
45-
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
45+
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
4646
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
47-
> {{alias}}( 3, x1, 2 )
47+
> {{alias}}( 4, x1, 2 )
4848
~-0.3333
4949

5050

@@ -83,8 +83,8 @@
8383
~0.3333
8484

8585
// Using offset parameter:
86-
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ];
87-
> {{alias}}.ndarray( 3, x, 2, 1 )
86+
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ];
87+
> {{alias}}.ndarray( 4, x, 2, 1 )
8888
~-0.3333
8989

9090
See Also

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ var ndarray = require( './ndarray.js' );
3636
*
3737
* @example
3838
* var x = [ 1.0, -2.0, NaN, 2.0 ];
39-
* var N = x.length;
4039
*
41-
* var v = nanmeanors( N, x, 1 );
40+
* var v = nanmeanors( 4, x, 1 );
4241
* // returns ~0.3333
4342
*/
4443
function nanmeanors( N, x, strideX ) {

lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,9 @@ var accessors = require( './accessors.js' );
3636
* @returns {number} arithmetic mean
3737
*
3838
* @example
39-
* var floor = require( '@stdlib/math/base/special/floor' );
40-
*
4139
* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ];
42-
* var N = floor( x.length / 2 );
4340
*
44-
* var v = nanmeanors( N, x, 2, 1 );
41+
* var v = nanmeanors( 4, x, 2, 1 );
4542
* // returns 1.25
4643
*/
4744
function nanmeanors( N, x, strideX, offsetX ) {

0 commit comments

Comments
 (0)