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

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

[Octave-bug-tracker] [bug #59552] "help" does not display Contents.m fil


From: Markus Mützel
Subject: [Octave-bug-tracker] [bug #59552] "help" does not display Contents.m file in @class or +namespace folders in the load path
Date: Fri, 27 Nov 2020 05:06:29 -0500 (EST)
User-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.67 Safari/537.36 Edg/87.0.664.47

Update of bug #59552 (project octave):

              Item Group:              Regression => Matlab Compatibility   
                  Status:                    None => Confirmed              
                 Release:                   5.2.0 => dev                    
                 Summary: Contents.m files no longer work. => "help" does not
display Contents.m file in @class or +namespace folders in the load path

    _______________________________________________________

Follow-up Comment #1:

I tried with a Contents.m file in a "normal" folder in the load path and this
seems to work as expected with 5.2.0 and 6.0.92:

>> addpath D:\SVN\Octave\bug59552_Contents
>> help bug59552_Contents
D:\SVN\Octave\bug59552_Contents\Contents.m:

 This is some text.


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.


I tried the same with a Contents.m file in a +namespace or @class folder, and
the same does *not* work. It *does* work if I pass these folders with their
full path to "help".
To check if this is a regression, I tried with 6.0.92, 5.2.0, 4.4.1 and 4.2.2
(those are the versions that are available to me atm), and it worked for none
of them.
If this ever worked, it is broken for quite some time.

Fwiw, in Matlab R2020b where I placed a Contents.m file with different content
in each of these folders:

>> dir D:\SVN\Octave\bug59552_Contents

+namespace1    .              ..             @class1        Contents.m    
normal_folder  

>> addpath D:\SVN\Octave\bug59552_Contents
>> help class1
class1 methods:

Contents - This is some text in a class folder.

>> help namespace1
  This is some text in a namespace folder.

>> help normal_folder

normal_folder not found.

Use the Help browser search field to search the documentation, or
type "help help" for help command options, such as help for methods.

>> help bug59552_Contents
  This is some text.



    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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