[Octave-bug-tracker] [bug #65220] get_help_text returns docstring from parent methods

[John W. Eaton]

Follow-up Comment #19, bug#65220 (group octave):

Here is what I propose to do, regardless of any weird quirks of Matlab
behavior:

The documentation for the class itself will be the first non-copyright comment
at the top of the file prior to the classdef keyword or, if that is missing,
the first comment inside the classdef block.

The documentation for the constructor and methods will be the first comment
inside the function.  If that is missing, then the function will be
undocumented.

The documentation for properties will be the comment preceding the property
name in the properties block.

For "help classname" display the documentation for the class.  If that is
empty, display the documentation for the constructor.

For "help classname.classname" display the documentation for the class
constructor.  If that is empty but the class itself is documented, display
that.

Does that make sense?  Is it at all close to Matlab behavior?  That's what my
test case was trying to determine.






    _______________________________________________________

Reply to this item at:

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

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