Skip to content

Commit fea3862

Browse files
authored
Apply suggestions from code review
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
1 parent 526ab9d commit fea3862

4 files changed

Lines changed: 12 additions & 8 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ The function accepts the following options:
7474

7575
## Notes
7676

77-
- 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.
78-
- 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.
77+
- If `options.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 `options.dims = [0, 1]`, the function rotates the plane counterclockwise.
78+
- If `options.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 `options.dims = [0, 1]`, the function rotates the plane clockwise.
7979
- Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
8080

8181
</section>

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
Returns a read-only view of an input ndarray rotated 90 degrees in a
44
specified plane.
55

6-
If `k > 0`, the function rotates the plane from the first specified
6+
If `options.k > 0`, the function rotates the plane from the first specified
77
dimension toward the second specified dimension. This means that, for a
8-
two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane
9-
counterclockwise.
8+
two-dimensional ndarray and `options.dims = [0, 1]`, the function rotates
9+
the plane counterclockwise.
1010

11-
If `k < 0`, the function rotates the plane from the second specified
11+
If `options.k < 0`, the function rotates the plane from the second specified
1212
dimension toward the first specified dimension. This means that, for a
13-
two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane
14-
clockwise.
13+
two-dimensional ndarray and `options.dims = [0, 1]`, the function rotates
14+
the plane clockwise.
1515

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ interface Options {
4343
*
4444
* ## Notes
4545
*
46+
* - If `options.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 `options.dims = [0, 1]`, the function rotates the plane counterclockwise.
47+
* - If `options.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 `options.dims = [0, 1]`, the function rotates the plane clockwise.
4648
* - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
4749
*
4850
* @param x - input array

lib/node_modules/@stdlib/ndarray/rot90/lib/main.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ var format = require( '@stdlib/string/format' );
3737
*
3838
* ## Notes
3939
*
40+
* - If `options.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 `options.dims = [0, 1]`, the function rotates the plane counterclockwise.
41+
* - If `options.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 `options.dims = [0, 1]`, the function rotates the plane clockwise.
4042
* - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
4143
*
4244
* @param {ndarray} x - input array

0 commit comments

Comments
 (0)