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

[Rik]

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

                 Summary: Feature Request: provide function prototype as
docstring when no documentation exists
                   Group: GNU Octave
               Submitter: rik5
               Submitted: Mon 05 Feb 2024 02:43:58 PM PST
                Category: Documentation
                Severity: 1 - Wish
                Priority: 5 - Normal
              Item Group: Feature Request
                  Status: Confirmed
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
                 Release: dev
         Discussion Lock: Any
        Operating System: Any
           Fixed Release: None
         Planned Release: None


    _______________________________________________________

Follow-up Comments:


-------------------------------------------------------
Date: Mon 05 Feb 2024 02:43:58 PM PST By: Rik <rik5>
This is a very small thing.  When a programmer tries help() on a function
without documentation Octave emits an error that the function is undocumented.
 Matlab, however, prints the function prototype which might be at least mildly
useful to the programmer.

Here is a simple m-file no_doc_fcn.m that shows what I'm looking for


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


And when I try using help() I get


octave:1> help no_doc_fcn
error: help: 'no_doc_fcn' is not documented


What would be nice is something like


'no_doc_fcn' is a function from the file /home/xxx/no_doc_fcn.m

  y = no_doc_fcn (arg1, arg2, arg3)










    _______________________________________________________

Reply to this item at:

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

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