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

[Andreas Bertsatos]

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

Perhaps I was not very clear about it. I suggest that it should support both
in the sense that it looks in both places, so if some older classdef have the
documentation before the function and not inside it, then get_help_text should
return the one before instead of returning that documentation is not present.

I don't mind changing the docstrings place inside the classdef files in the
statistics package, I am more concerned that if we get such a significant
disruption in backwards compatibility, then I won't be able to support help
for both Octave > 9 and Octave < 9. Unless, the current (Octave <=8.4)
implementation of get_help_text already supports returning documentation from
inside the method functions.

The other issue is that it feels a bit counter-intuitive to generally have the
documentation for general functions before the function block in the m file,
and in classdef files, requiring the documentation to be inside the function
block.

[comment #21 comment #21:]
> Which comment should be used for the method documentation if both are
present?
> 
> For compatibility with Matlab, that appears to be the one inside the
function.
> 
> For backward compatibility with previous versions of Octave, it would be the
one before the function definition.
> 
> I don't see how we can do both.
> 


    _______________________________________________________

Reply to this item at:

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

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