Skip to content

Commit c1fc392

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

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

  • lib/node_modules/@stdlib/ndarray/base/rotr90/docs

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,12 @@
55
If `k > 0`, the function rotates the matrix clockwise. If `k < 0`, the
66
function rotates the matrix counterclockwise.
77

8-
If provided an ndarray with fewer than two dimensions, the function returns
9-
a new view of the input ndarray.
8+
The returned ndarray is always a *view* of the input ndarray. Accordingly,
9+
writing to the original ndarray will mutate the returned ndarray and vice
10+
versa.
1011

11-
The returned ndarray is a *view* of the input ndarray. Accordingly, writing
12-
to the original ndarray will mutate the returned ndarray and vice versa.
13-
14-
The `writable` parameter only applies to ndarray constructors supporting
15-
read-only instances.
12+
If provided an ndarray with fewer than two dimensions, the function does not
13+
perform a rotation and simply returns a new view of the input ndarray.
1614

1715
Parameters
1816
----------
@@ -23,12 +21,14 @@
2321
Number of times to rotate by 90 degrees.
2422

2523
writable: boolean
26-
Boolean indicating whether the returned ndarray should be writable.
24+
Boolean indicating whether a returned ndarray should be writable. This
25+
parameter only applies to ndarray constructors which support read-only
26+
instances.
2727

2828
Returns
2929
-------
3030
out: ndarray
31-
Output array.
31+
Output array view.
3232

3333
Examples
3434
--------

0 commit comments

Comments
 (0)