bugGNU Octave - Bugs: bug #57400, metaclass function needs...

 
 

bug #57400: metaclass function needs documentation section in oop.txi

Submitter:  Rik <rik5>
Submitted:  Thu 12 Dec 2019 05:06:58 PM UTC
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Confirmed Assigned to:  None
Originator Name:  Open/Closed:  * Open
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Thu 12 Dec 2019 05:14:45 PM UTC, comment #1: 

Other class objects to document

meta.class
meta.method
meta.package
meta.property

Rik <rik5>
Project Administrator
Thu 12 Dec 2019 05:06:58 PM UTC, original submission:  

The metadata function exists in Octave, but there is no @DOCSTRING reference in the manual in the Object Oriented Programming (oop.txi) chapter.

Ideally, there should be a new documentation node under the classdef documentation with an appropriate title ("Inspecting Classes"?).  The node should then say a few words about why a programmer would want to look at the details of a class, and then include "@DOCSTRING(metaclass)".  Also would be nice if the metaclass documentation described the alternative syntax "?ClassName".

Bonus points if the documentation explains a bit about what a metaclass object is and what the other derivative objects are such as meta.property object.  As an example, one could use

mc = ?containers.Map

and then talk about the results.

Rik <rik5>
Project Administrator

 

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

     

     

     

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2019-12-16 rik5 Summarymetaclass function needs section in oop.txi metaclass function needs documentation section in oop.txi

    Back to the top

    Powered by Savane 3.9