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

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

[Octave-bug-tracker] [bug #65258] Feature Request: provide function prot


From: John W. Eaton
Subject: [Octave-bug-tracker] [bug #65258] Feature Request: provide function prototype as docstring when no documentation exists
Date: Wed, 20 Mar 2024 13:07:14 -0400 (EDT)

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

If there is a constructor defined in a class but no doc for either the class
or constructor:


classdef foo_class
  methods
    function obj = foo_class (a, b, c = 2, ~)
    end
  end
end


then I see


octave:1> help foo_class
'foo_class' is a class constructor from the file
/scratch/jwe/build/octave/foo_class.m

undocumented function:  obj = foo_class (a, b, c = 2, ~)

[...]


I have an idea about how to improve the output so that we would say
"undocumented constructor: ..." and to also display "default constructor:  obj
= foo_class ()" if no constructor is explicitly defined.  I'll try to do that
and upload another patch soon.


    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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