Skip to content

Commit 40768ac

Browse files
committed
fix: readme and repl
--- 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: 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 de4fffa commit 40768ac

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ var mean = require( '@stdlib/stats/base/mean' );
5353

5454
#### mean( N, x, strideX )
5555

56-
Computes the [arithmetic mean][arithmetic-mean] of a strided array `x`.
56+
Computes the [arithmetic mean][arithmetic-mean] of a strided array.
5757

5858
```javascript
5959
var x = [ 1.0, -2.0, 2.0 ];
@@ -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 array 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 ];
@@ -97,7 +97,6 @@ Computes the [arithmetic mean][arithmetic-mean] of a strided array using alterna
9797

9898
```javascript
9999
var x = [ 1.0, -2.0, 2.0 ];
100-
var N = x.length;
101100

102101
var v = mean.ndarray( x.length, x, 1, 0 );
103102
// returns ~0.33333
@@ -107,7 +106,7 @@ The function has the following additional parameters:
107106

108107
- **offsetX**: starting index for `x`.
109108

110-
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
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 element in `x` starting from the second element
111110

112111
```javascript
113112
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
{{alias}}( N, x, strideX )
33
Computes the arithmetic mean of a strided array.
44

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

8-
Indexing is relative to the first index. To introduce an offset, use a
9-
typed array view.
8+
Indexing is relative to the first index. To introduce an offset, use a typed
9+
array view.
1010

1111
If `N <= 0`, the function returns `NaN`.
1212

0 commit comments

Comments
 (0)