[Octave-bug-tracker] [bug #57400] metaclass function needs section in oop.txi

[Rik]

URL:
  <https://savannah.gnu.org/bugs/?57400>

                 Summary: metaclass function needs section in oop.txi
                 Project: GNU Octave
            Submitted by: rik5
            Submitted on: Thu 12 Dec 2019 09:06:58 AM PST
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: Confirmed
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: Any

    _______________________________________________________

Details:

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.





    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?57400>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/