Skip to content

Commit b5fb2f8

Browse files
committed
docs: update notes
--- 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: passed - task: lint_license_headers status: passed ---
1 parent b9502d5 commit b5fb2f8

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

lib/node_modules/@stdlib/ndarray/base/rot90/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The function accepts the following arguments:
7272
## Notes
7373

7474
- If `k > 0`, the function rotates the plane from the first specified dimension toward the second specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane counterclockwise.
75-
- If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [1, 0]`, the function rotates the plane clockwise.
75+
- If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane clockwise.
7676
- Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
7777
- The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
7878
- The returned ndarray is a **view** of the input ndarray. Accordingly, writing to the original ndarray will **mutate** the returned ndarray and vice versa.

lib/node_modules/@stdlib/ndarray/base/rot90/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
If `k < 0`, the function rotates the plane from the second specified
1111
dimension toward the first specified dimension. This means that, for a two-
12-
dimensional ndarray and `dims = [1, 0]`, the function rotates the plane
12+
dimensional ndarray and `dims = [0, 1]`, the function rotates the plane
1313
clockwise.
1414

1515
Each provided dimension index must reside on the interval [-ndims, ndims-1].

lib/node_modules/@stdlib/ndarray/base/rot90/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { Collection } from '@stdlib/types/array';
2929
* ## Notes
3030
*
3131
* - If `k > 0`, the function rotates the plane from the first specified dimension toward the second specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane counterclockwise.
32-
* - If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [1, 0]`, the function rotates the plane clockwise.
32+
* - If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane clockwise.
3333
* - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
3434
*
3535
* @param x - input array

0 commit comments

Comments
 (0)