[Octave-bug-tracker] [bug #65258] Feature Request: provide function prototype as docstring when no documentation exists

[Nicholas Jankowski]

Follow-up Comment #6, bug #65258 (group octave):

testing against default, I now get the following with the comment #0 checks:

defined at the CLI:

function y = no_doc_fcn (arg1, arg2, arg3)
end



>> help no_doc_fcn
'no_doc_fcn' is a command-line function

undocumented function:  y = no_doc_fcn (arg1, arg2, arg3)

Additional help for built-in functions and operators is
available in the online version of the manual.  Use the command
'doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at https://www.octave.org and via the help@octave.org
mailing list.



same function saved to a file:

>> help no_doc_fcn
'no_doc_fcn' is a function from the file
/home/nrjank/source/builds/no_doc_fcn.m

undocumented function:  y = no_doc_fcn (arg1, arg2, arg3)

Additional help for built-in functions and operators is
available in the online version of the manual.  Use the command
'doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at https://www.octave.org and via the help@octave.org
mailing list.


I see there's also a change to undoc'd classes.  if i create a dummy class
file no_doc_class.m:


classdef no_doc_class
  properties
  endproperties

  methods
  endmethods
endclassdef


I get:

>> help no_doc_class
'no_doc_class' is a class constructor from the file
/home/nrjank/source/builds/no_doc_class.m

no_doc_class is an undocumented class

Additional help for built-in functions and operators is
available in the online version of the manual.  Use the command
'doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at https://www.octave.org and via the help@octave.org
mailing list.


This seems to be working and is an improvement. With all of the changes to
looking for help inside classdef files, is there other expected behavior that
should be checked depending on whether any parts of the file have a help
string?


    _______________________________________________________

Reply to this item at:

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

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