bugGNU Octave - Bugs: bug #54336, Power operator docstring mentions...

 
 

bug #54336: Power operator docstring mentions nonexist function "realroot"

Submitter:  None
Submitted:  Thu 19 Jul 2018 02:07:56 AM 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:  * 4.4.0
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 19 Jul 2018 03:25:07 PM UTC, comment #1: 

Thanks for catching that.  I checked in your change on the stable branch here (https://hg.savannah.gnu.org/hgweb/octave/rev/cf452aa01cd5).  Marking as fixed and closing report.

Rik <rik5>
Group administrator
Thu 19 Jul 2018 02:07:56 AM UTC, original submission:  

The docstring of operator ^ ** mentions "realroot" which is not an Octave function.
According to the docstring of operator .^ .** , it seems that it might be "realpow".


--- a/libinterp/op-kw-docs
+++ b/libinterp/op-kw-docs
@@ -178,7 +178,7 @@
 Power operator.

 This may return complex results for real inputs.  Use @code{realsqrt},
-@code{cbrt}, @code{nthroot}, or @code{realroot} to obtain real results when
+@code{cbrt}, @code{nthroot}, or @code{realpow} to obtain real results when
 possible.
 @seealso{power, ^, .**, .^, realpow, realsqrt, cbrt, nthroot}
 @end deftypefn
@@ -189,7 +189,7 @@
 Power operator.

 This may return complex results for real inputs.  Use @code{realsqrt},
-@code{cbrt}, @code{nthroot}, or @code{realroot} to obtain real results when
+@code{cbrt}, @code{nthroot}, or @code{realpow} to obtain real results when
 possible.
 @seealso{power, **, .^, .**, realpow, realsqrt, cbrt, nthroot}
 @end deftypefn


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)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-07-19 rik5 StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-4448.
    Corresponding source code