Mercurial > jwe > octave
changeset 27037:df32e0cf0992 stable
doc: Fix names of options in issorted (bug #56087).
* data.cc (Fissorted): Change "ascending" to "ascend" and "descending" to
"descend" in documentation of MODE argument.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 08 Apr 2019 08:22:15 -0700 |
parents | 4a2cb3392014 |
children | ca0230d3efbf 32d9f57d7245 |
files | libinterp/corefcn/data.cc |
diffstat | 1 files changed, 8 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/data.cc Thu Apr 04 11:29:13 2019 -0700 +++ b/libinterp/corefcn/data.cc Mon Apr 08 08:22:15 2019 -0700 @@ -6862,16 +6862,14 @@ @deftypefn {} {} issorted (@var{a}) @deftypefnx {} {} issorted (@var{a}, @var{mode}) @deftypefnx {} {} issorted (@var{a}, "rows", @var{mode}) -Return true if the array is sorted according to @var{mode}, which -may be either @qcode{"ascending"}, @qcode{"descending"}, or -@qcode{"either"}. - -By default, @var{mode} is @qcode{"ascending"}. NaNs are treated in the -same manner as @code{sort}. - -If the optional argument @qcode{"rows"} is supplied, check whether -the array is sorted by rows as output by the function @code{sortrows} -(with no options). +Return true if the array is sorted according to @var{mode}, which may be either +@qcode{"ascend"}, @qcode{"descend"}, or @qcode{"either"}. + +By default, @var{mode} is @qcode{"ascend"}. NaNs are treated in the same +manner as @code{sort}. + +If the optional argument @qcode{"rows"} is supplied, check whether the array is +sorted by rows as output by the function @code{sortrows} (with no options). This function does not support sparse matrices. @seealso{sort, sortrows}