[Octave-bug-tracker] [bug #42791] lookfor index error for private functions without texinfo

[Andreas Weber]

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

                 Summary: lookfor index error for private functions without
texinfo
                 Project: GNU Octave
            Submitted by: andy1978
            Submitted on: Thu 17 Jul 2014 01:44:34 PM GMT
                Category: None
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: None
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: GNU/Linux

    _______________________________________________________

Details:

hg id cc8aaf9c9e33.

During build mk_doc_cache.m creates doc-cache from DOCSTRINGS and skips
__functions__ but not other functions in /private dirs.

If in these files there is no valid texinfo block (imwrite_filename.m,
shell.m, imageIO.m) the generated cache contains the hole function text as
function name.

This then triggers a indexing problem in the display routine of lookfor.m
where the length of the function name is bigger than the terminal_width -
indent. For example:


octave:2> lookfor imwrite
imwrite             Write images in various file formats.
imwrite_filename The input check for imwrite needs to be done twice, once when
imwrite is called the first time to find where the filename is, and a second
time by __imwrite__ after imformats decides what function to use.  Because a
user can, and is encouraged to, get a function handle to __imwrite__, the
input check is also done there.  In addition, the input check for imwrite is
not that straightforward in order to support the multiple ways the function
can be called, and 
error: lookfor: subscript indices must be either positive integers less than
2^31 or logicals
error: called from:
error:   /usr/local/share/octave/4.1.0+/m/help/lookfor.m at line 168, column
9


A quick fix would be to add "Undocumented internal function." texinfo blocks
to shell.m, imwrite_filename.m and imageIO.m or to check is the fullpath
contains "private".






    _______________________________________________________

Reply to this item at:

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

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