bugGNU Octave - Bugs: bug #54249, essential explanation on class and...

 
 

bug #54249: essential explanation on class and classdef usage

Submitter:  None
Submitted:  Thu 05 Jul 2018 06:32:07 AM UTC
 
Category:  Documentation Severity:  2 - Minor
Priority:  3 - Low Item Group:  Documentation
Status:  Duplicate Assigned to:  siko1056
Originator Name:  thomasp Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * 4.4.0
Operating System:  * Any
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Thu 05 Jul 2018 08:43:22 AM UTC, comment #1: 

Thank you for your report.  Please refer to bug #50729 for further comments and suggestions to improve the classdef, e.g. OOP (object oriented programming), section of the manual.

The manual ([1], as of 2018-07-05) refers to Octave 4.4.0, where classdef is still an incomplete implementation.

If you are willing to improve the documentation, you are welcome to update the respective sections in [2] and upload them to bug #50729 as attachment.  GNU Octave uses Texinfo [3] for its documentation.

Due to other obligations, I currently don't have to time for an extensive rewriting and testing.

[2] https://hg.savannah.gnu.org/hgweb/octave/raw-file/5f9fa229cc8a/doc/interpreter/oop.txi
[3] https://www.gnu.org/software/texinfo/

Kai Torben Ohlhus <siko1056>
Project Member
Thu 05 Jul 2018 06:32:07 AM UTC, original submission:  

In the documentation of the "class" and "classdef" keywords on the octave.org website ([1], as of 2018-07-05), the following pretty essential information is missing:

1. In section 34. or 34.1, there should be mention that a new class definition syntax using "classdef" is existing which is more powerful than old-style class definition.

2. In section 34.2, there should be mention (e.g. by example) that in old-style class objects, methods must be accessed like "disp(obj, further_args)". (for Matlb compatibility)

3. In the event of a change in the class code, apparently the internally stored class definition needs to be updated manually by user. This clearly must be mentioned (e.g. in 34.1 and 34.6?). Possibly, a warning should be produced if a code change in the definition can be detected (e.g. on object creation).

----------
[1] https://octave.org/doc/interpreter/
section 34.

Anonymous

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

Digest:
   bug dependencies.

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by siko1056 (Posted a comment)
  •  

    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 project members can vote.

     

     

     

     

    Follow 8 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-07-05 siko1056 Assigned toNone siko1056
    2018-07-05 siko1056 Dependencies- Depends on bugs #50729
    2018-07-05 siko1056 Severity3 - Normal 2 - Minor
        Priority5 - Normal 3 - Low
        StatusNone Duplicate
        Open/ClosedOpen Closed
        Release4.0.0 4.4.0
        Operating SystemMicrosoft Windows Any

    Back to the top


    Powered by Savane 3.9