Skip to content

Commit d81e52b

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

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

  • lib/node_modules/@stdlib/ndarray/diagonal/docs

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
Function options.
1919

2020
options.k: integer (optional)
21-
Diagonal offset. The diagonal offset is interpreted as
22-
`column - row`. Accordingly, when `options.k = 0`, the function
23-
returns the main diagonal; when `options.k > 0`, the function returns
24-
the diagonal above the main diagonal; and when `options.k < 0`, the
25-
function returns the diagonal below the main diagonal. Default: 0.
21+
Diagonal offset. The diagonal offset is interpreted as `column - row`.
22+
Accordingly, when equal to zero, the function returns the main diagonal.
23+
When greater than zero, the function returns the diagonal above the main
24+
diagonal. When less than zero, the function returns the diagonal below
25+
the main diagonal. Default: 0.
2626

2727
options.dims: ArrayLikeObject<integer> (optional)
2828
Dimension indices defining the plane from which to extract the

0 commit comments

Comments
 (0)