bugGNU Octave - Bugs: bug #56087, issorted docstring needs update...

 
 

bug #56087: issorted docstring needs update (option of "ascend" or "descend")

Submitted by:  None
Submitted on:  Sat 06 Apr 2019 12:30:10 PM UTC  
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  Closed Release:  5.1.0
Operating System:  Any

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Mon 08 Apr 2019 03:23:18 PM UTC, comment #1: 

I fixed the problem here (https://hg.savannah.gnu.org/hgweb/octave/rev/df32e0cf0992) and also re-wrapped the documentation to fit in 80 columns.  Thanks for the patch.

Rik <rik5>
Project Administrator
Sat 06 Apr 2019 12:30:10 PM UTC, original submission:  

The issorted function now uses a direction option of "ascend" or "descend"
instead of "ascending" and "descending".
( bug #54147
changeset http://hg.savannah.gnu.org/hgweb/octave/rev/b7db401e1a99 )

But the docstring is still old.  Here is a patch:

--- a/libinterp/corefcn/data.cc
+++ b/libinterp/corefcn/data.cc
@@ -6863,10 +6863,9 @@
@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"}.
+may be either @qcode{"ascend"}, @qcode{"descend"}, or @qcode{"either"}.

-By default,  @var{mode} is @qcode{"ascending"}.  NaNs are treated in the
+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

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by None (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

     

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2019-04-08 rik5 StatusNone => Fixed
        Open/ClosedOpen => Closed

    Back to the top


    Powered by Savane 3.5