[Octave-bug-tracker] [bug #48479] Typo in fminunc documentation

[anonymous]

URL:
  <http://savannah.gnu.org/bugs/?48479>

                 Summary: Typo in fminunc documentation
                 Project: GNU Octave
            Submitted by: None
            Submitted on: Mon 11 Jul 2016 09:43:33 PM UTC
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: None
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 4.0.3
        Operating System: Any

    _______________________________________________________

Details:

The documentation for the fminunc function contains this phrase at the end, 
<quote>
The algorithm used by *fminsearch* is a gradient search which depends on the
objective function being differentiable. If the function has discontinuities
it may be better to use a derivative-free algorithm such as *fminsearch*.
</quote>

(emphasis mine)

It should say "The algorithm used by *fminunc* is a gradient search[...]". 
Otherwise the phrase is recommending to use fminsearch instead of fminsearch.
:)

This is all assuming I've parsed the english correctly!

Patch attached with the one-liner.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Mon 11 Jul 2016 09:43:33 PM UTC  Name: fminunc.m.diff  Size: 695B   By:
None

<http://savannah.gnu.org/bugs/download.php?file_id=37816>

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?48479>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/