[Octave-bug-tracker] [bug #64065] help text in m-file incorrectly identified

[Rik]

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

                 Summary: help text in m-file incorrectly identified
                   Group: GNU Octave
               Submitter: rik5
               Submitted: Tue 18 Apr 2023 03:43:03 PM PDT
                Category: Interpreter
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Incorrect Result
                  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: Tue 18 Apr 2023 03:43:03 PM PDT By: Rik <rik5>
Consider the following function fcn_help.m


function r = fcn_help (x)
  r = x;   # Single-line comment, not documentation for function
endfunction


Calling print_usage() incorrectly identifies the single-line comment as the
documentation for the entire function.


print_usage ('fcn_help')
error: Invalid call to fcn_help.  Correct usage is:

 Single-line comment, not documentation for function


The problem can be traced further back to function get_help_text() in
libinterp/corefcn/help.cc.

It seems to me that Octave should be checking for comments that take an entire
line as being possible documentation, and not comments that are attached to a
piece of code as this one is.







    _______________________________________________________
File Attachments:


-------------------------------------------------------
Date: Tue 18 Apr 2023 03:43:03 PM PDT  Name: fcn_help.m  Size: 103B   By: rik5

<http://savannah.gnu.org/bugs/download.php?file_id=54637>

    _______________________________________________________

Reply to this item at:

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

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