bugGNU Octave - Bugs: bug #55120, small problem of example code in...

 
 

bug #55120: small problem of example code in chapter OOP

Submitter:  None
Submitted:  Wed 28 Nov 2018 03:56:02 AM UTC
   
 
Category:  Documentation Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  siko1056
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * dev
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 28 Nov 2018 08:51:38 AM UTC, comment #1: 

Thank you for your report.

I added the following changeset, that will fix this documentation issue in the upcoming version of Octave.  https://hg.savannah.gnu.org/hgweb/octave/rev/64b972120ec3

Kai Torben Ohlhus <siko1056>
Group Member
Wed 28 Nov 2018 03:56:02 AM UTC, original submission:  

In the chapter OOP, an example says that "roots" is a method of "polynomial".

$  grep -C5 -n roots doc/interpreter/oop.txi
153-For example:
154-
155-@example
156-@group
157-p = polynomial ([1, 0, 1]);
158:ismethod (p, "roots")
159-  @result{} 1
160-@end group
161-@end example
162-
163-@node Class Methods


But in this whole chapter, no statement mentions that "roots" is a method of "polynomial".

$  grep EXAMPLEFILE.*@polynomial doc/interpreter/oop.txi
@EXAMPLEFILE(@polynomial/polynomial.m)
@EXAMPLEFILE(@polynomial/disp.m)
@EXAMPLEFILE(@polynomial/get.m)
@EXAMPLEFILE(@polynomial/set.m)
@EXAMPLEFILE(@polynomial/subsref.m)
@EXAMPLEFILE(@polynomial/end.m)
@EXAMPLEFILE(@polynomial/polyval.m)
@EXAMPLEFILE(@polynomial/plot.m)
@EXAMPLEFILE(@polynomial/double.m)
@EXAMPLEFILE(@polynomial/mtimes.m)
@EXAMPLEFILE(@polynomial/polynomial_superiorto.m)


Although the file "examples/code/@polynomial/roots.m" does exist in the source tree, the document reader does not know this.

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 siko1056 (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 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-11-28 siko1056 Severity3 - Normal 2 - Minor
        StatusNone Fixed
        Assigned toNone siko1056
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-bb6a.
    Corresponding source code