Skip to content

Commit 4efc1ee

Browse files
committed
docs: update parameter descriptions
--- 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 35e5fcc commit 4efc1ee

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ The function has the following parameters:
5252

5353
- **N**: number of indexed elements.
5454
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
55-
- **strideX**: index increment for `x`.
55+
- **strideX**: stride length for `x`.
5656
- **y**: output [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
57-
- **strideY**: index increment for `y`.
57+
- **strideY**: stride length for `y`.
5858

59-
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative maximum absolute value of every other element in `x`,
59+
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative minimum absolute value of every other element in `x`,
6060

6161
```javascript
6262
var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
Input array.
2020

2121
strideX: integer
22-
Index increment for `x`.
22+
Stride length for `x`.
2323

2424
y: Array<number>|TypedArray
2525
Output array.
2626

2727
strideY: integer
28-
Index increment for `y`.
28+
Stride length for `y`.
2929

3030
Returns
3131
-------
@@ -40,7 +40,7 @@
4040
> {{alias}}( x.length, x, 1, y, 1 )
4141
[ 1.0, 1.0, 1.0 ]
4242

43-
// Using `N` and `stride` parameters:
43+
// Using `N` and stride parameters:
4444
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];
4545
> y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
4646
> {{alias}}( 3, x, 2, y, 2 )
@@ -74,7 +74,7 @@
7474
Input array.
7575

7676
strideX: integer
77-
Index increment for `x`.
77+
Stride length for `x`.
7878

7979
offsetX: integer
8080
Starting index for `x`.
@@ -83,7 +83,7 @@
8383
Output array.
8484

8585
strideY: integer
86-
Index increment for `y`.
86+
Stride length for `y`.
8787

8888
offsetY: integer
8989
Starting index for `y`.

0 commit comments

Comments
 (0)