octave-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Andreas Bertsatos
Subject: [Octave-bug-tracker] [bug #65220] get_help_text returns docstring from parent methods
Date: Mon, 29 Jan 2024 17:26:33 -0500 (EST)

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

Although it is not clearly stated in the matlab documentation referenced by
John, running the example class ('someClass') from this documentation in
MATLAB R2022b uields the following

>> help someClass
  someClass Summary of this class goes here
    Detailed explanation goes here

    Documentation for someClass

>> help someClass.someClass
  Summary of constructor

    Documentation for someClass/someClass

>> 

So making help and get_help_text behaving accordingly also fixes MATLAB
compatibility. Of course, in Octave it is necessary that get_help_text looks
for texinfo before the function because AFAIK all core functions and in many
packages as well follow this template, i.e. the help docstring is right before
the function declaration.


    _______________________________________________________

Reply to this item at:

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

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




reply via email to

[Prev in Thread] Current Thread [Next in Thread]