[Octave-bug-tracker] [bug #46008] Help function fails to return help header for subfunctions and nested functions

[Tasos Papastylianou]

URL:
  <http://savannah.gnu.org/bugs/?46008>

                 Summary: Help function fails to return help header for
subfunctions and nested functions
                 Project: GNU Octave
            Submitted by: tpapastylianou
            Submitted on: Sun 20 Sep 2015 15:49:14 GMT
                Category: Octave Function
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Incorrect Result
                  Status: None
             Assigned to: None
         Originator Name: Tasos Papastylianou <tpapastylianou>
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: Any

    _______________________________________________________

Details:

To replicate:

* in file Foo.m:


function Foo
% Function Foo help header
  disp('hello from Foo');
  Bar;
  Fizz;
  
  function Fizz
  % Nested Function Fizz help header
    disp('hello from Fizz');
  end
end

function Bar
% Subfunction Bar help header
  disp('hello from Bar');
end


* at the terminal:


>> help Foo>Bar
error: help: 'Foo>Bar' is not documented

>> help Foo>Fizz
error: help: 'Foo>Fizz' is not documented
>>


* (matlab output for reference):


>> help Foo>Bar
  Subfunction Bar help header

>> help Foo>Fizz
  Nested Function Fizz help header


The error seems to stem from get_help_text which is a built-in
(libinterp/corefcn/help.cc), called by help.m
This seems to return format = "not documented" back to help.m instead of a
more appropriate value.





    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?46008>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/