bugGNU Octave - Bugs: bug #48479, Typo in fminunc documentation

 
 

bug #48479: Typo in fminunc documentation

Submitted by:  None
Submitted on:  Mon 11 Jul 2016 09:43:33 PM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: None
Status: FixedAssigned to: None
Originator Name: Originator Email: -unavailable-
Open/Closed: ClosedRelease: 4.0.3
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 11 Jul 2016 10:12:11 PM UTC, comment #1:

Thanks for catching this typo, I applied your patch

http://hg.savannah.gnu.org/hgweb/octave/rev/d3cef63f79ac

Mike Miller <mtmiller>
Project Administrator
Mon 11 Jul 2016 09:43:33 PM UTC, original submission:

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.

Anonymous

 

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

Attach File(s):
   
   
Comment:
   

Attached Files
file #37816:  fminunc.m.diff added by None (695B - application/octet-stream)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by mtmiller (Posted a comment)
  •  

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

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Mon 11 Jul 2016 10:12:11 PM UTCmtmillerStatusNone=>Fixed
      Open/ClosedOpen=>Closed
    Mon 11 Jul 2016 09:43:33 PM UTCNoneAttached File-=>Added fminunc.m.diff, #37816

    Back to the top


    Powered by Savane 3.1-cleanup1