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

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

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


From: Rik
Subject: [Octave-bug-tracker] [bug #65220] get_help_text returns docstring from parent methods
Date: Sat, 3 Feb 2024 14:08:26 -0500 (EST)

Update of bug#65220 (group octave):

                  Status:                   Fixed => In Progress            
             Open/Closed:                  Closed => Open                   

    _______________________________________________________

Follow-up Comment #51:

Re-opening bug report.  I found an odd case where the wrong comment is used.

Minimum working example uses file foobar.m shown below and attached.


classdef foobar

  methods

    function out = foo (obj, arg1, arg2)
      out = "Called function foo()";
      % No documentation for function.
      % Try 'help foobar.foo' 
      % Matlab: returns function signature "out = foo (obj, arg1, arg2)"
      % Octave: returns error 
    end

  end

end


I'm working out of a build tree.  I don't think it is a problem with
run-octave, but I'll document the steps exactly.


cd DEVELOPMENT_DIRECTORY
mkdir fcndir
cp foobar.m fcndir/


And then do this sequence in Octave


run-octave -f
addpath fcndir
help foobar.foo
'foobar.foo' is a function from the file
/home/rik/wip/Projects_Mine/octave-stable/fcndir/foobar.m

 No documentation for function.
 Try 'help foobar.foo' 
 Matlab: returns function signature "out = foo (obj, arg1, arg2)"
 Octave: returns error 


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.


get_help_text is incorrectly locating help text that occurs after an
executable statement in method foo.  But, it gets weirder.  If you ask for
help about the class then the help system is reset and it no longer finds help
on the method.


help foobar
error: help: 'foobar' not found
help foobar.foo
error: help: 'foobar.foo' not found



(file #55662)

    _______________________________________________________

Additional Item Attachment:

File name: foobar.m                       Size:0 KB
    <https://file.savannah.gnu.org/file/foobar.m?file_id=55662>


    AGPL NOTICE

These attachments are served by Savane. You can download the corresponding
source code of Savane at
https://git.savannah.nongnu.org/cgit/administration/savane.git/snapshot/savane-7984227a52b1c59ed77ba5c9f7ef631497509617.tar.gz


    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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