Skip to content

Commit c0090dd

Browse files
authored
docs: document sort order
Signed-off-by: Athan <[email protected]>
1 parent c9d573c commit c0090dd

File tree

1 file changed

+1
-0
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp

1 file changed

+1
-0
lines changed

lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ The function has the following parameters:
7272
## Notes
7373

7474
- The input ndarray is sorted **in-place** (i.e., the input ndarray is **mutated**).
75+
- When the sort order is less than zero, the input ndarray is sorted in **decreasing** order. When the sort order is greater than zero, the input ndarray is sorted in **increasing** order. When the sort order is equal to zero, the input ndarray is left unchanged.
7576

7677
</section>
7778

0 commit comments

Comments
 (0)