Skip to content

Commit 4c14dc9

Browse files
committed
docs: minor clean-ups
--- 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 33f08ed commit 4c14dc9

File tree

1 file changed

+5
-7
lines changed
  • lib/node_modules/@stdlib/stats/base/range

1 file changed

+5
-7
lines changed

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,12 @@ var range = require( '@stdlib/stats/base/range' );
4040

4141
#### range( N, x, strideX )
4242

43-
Computes the [range][range] of a strided array `x`.
43+
Computes the [range][range] of a strided array.
4444

4545
```javascript
4646
var x = [ 1.0, -2.0, 2.0 ];
47-
var N = x.length;
4847

49-
var v = range( N, x, 1 );
48+
var v = range( x.length, x, 1 );
5049
// returns 4.0
5150
```
5251

@@ -56,7 +55,7 @@ The function has the following parameters:
5655
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
5756
- **strideX**: stride length for `x`.
5857

59-
The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
58+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
6059

6160
```javascript
6261
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
@@ -85,17 +84,16 @@ Computes the [range][range] of a strided array using alternative indexing semant
8584

8685
```javascript
8786
var x = [ 1.0, -2.0, 2.0 ];
88-
var N = x.length;
8987

90-
var v = range.ndarray( N, x, 1, 0 );
88+
var v = range.ndarray( x.length, x, 1, 0 );
9189
// returns 4.0
9290
```
9391

9492
The function has the following additional parameters:
9593

9694
- **offsetX**: starting index for `x`.
9795

98-
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 [range][range] for every other value in `x` starting from the second value
96+
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 [range][range] for every other element in `x` starting from the second element
9997

10098
```javascript
10199
var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];

0 commit comments

Comments
 (0)