Skip to content

Commit 2764a32

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: 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 5e977ba commit 2764a32

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

lib/node_modules/@stdlib/ndarray/iter/entries/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ v = iter.next().value;
6666

6767
The function accepts the following `options`:
6868

69-
- **order**: index iteration order. By default, the returned [iterator][mdn-iterator-protocol] returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manor, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses. Must be either `'row-major'` or `'column-major'`.
69+
- **order**: index iteration order. By default, the returned [iterator][mdn-iterator-protocol] returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses. Must be either `'row-major'` or `'column-major'`.
7070

7171
By default, the iterator iterates according to the layout order of the input [`ndarray`][@stdlib/ndarray/ctor]. To iterate according to a specified order, set the `order` option.
7272

lib/node_modules/@stdlib/ndarray/iter/entries/docs/repl.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
row-major input arrays, the last dimension indices increment fastest.
2828
For column-major input arrays, the first dimension indices increment
2929
fastest. To override the inferred order and ensure that indices
30-
increment in a specific manor, regardless of the input array's layout
30+
increment in a specific manner, regardless of the input array's layout
3131
order, explicitly set the iteration order. Note, however, that iterating
3232
according to an order which does not match that of the input array may,
3333
in some circumstances, result in performance degradation due to cache

lib/node_modules/@stdlib/ndarray/iter/entries/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ interface Options {
3535
*
3636
* ## Notes
3737
*
38-
* - By default, the returned iterator returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manor, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses.
38+
* - By default, the returned iterator returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses.
3939
*/
4040
order?: Order;
4141
}

lib/node_modules/@stdlib/ndarray/iter/values/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ v = iter.next().value;
6666

6767
The function accepts the following `options`:
6868

69-
- **order**: index iteration order. By default, the returned [iterator][mdn-iterator-protocol] returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manor, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses. Must be either `'row-major'` or `'column-major'`.
69+
- **order**: index iteration order. By default, the returned [iterator][mdn-iterator-protocol] returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses. Must be either `'row-major'` or `'column-major'`.
7070

7171
By default, the iterator iterates according to the layout order of the input [`ndarray`][@stdlib/ndarray/ctor]. To iterate according to a specified order, set the `order` option.
7272

lib/node_modules/@stdlib/ndarray/iter/values/docs/repl.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
row-major input arrays, the last dimension indices increment fastest.
2525
For column-major input arrays, the first dimension indices increment
2626
fastest. To override the inferred order and ensure that indices
27-
increment in a specific manor, regardless of the input array's layout
27+
increment in a specific manner, regardless of the input array's layout
2828
order, explicitly set the iteration order. Note, however, that iterating
2929
according to an order which does not match that of the input array may,
3030
in some circumstances, result in performance degradation due to cache

lib/node_modules/@stdlib/ndarray/iter/values/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ interface Options {
3535
*
3636
* ## Notes
3737
*
38-
* - By default, the returned iterator returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manor, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses.
38+
* - By default, the returned iterator returns values according to the layout order of the provided array. Accordingly, for row-major input arrays, the last dimension indices increment fastest. For column-major input arrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input array's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input array may, in some circumstances, result in performance degradation due to cache misses.
3939
*/
4040
order?: Order;
4141
}

0 commit comments

Comments
 (0)