bugGNU Octave - Bugs: bug #45045, documentation cache for octave...

 
 

bug #45045: documentation cache for octave packages does not include autoload functions

Submitter:  CarnĂ« Draug <carandraug>
Submitted:  Thu 07 May 2015 03:33:54 PM UTC
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Incorrect Result
Status:  Confirmed Assigned to:  None
Originator Name:  Open/Closed:  * Open
Release:  * dev Operating System:  * GNU/Linux
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       

 

Sun 10 May 2015 09:12:25 PM UTC, comment #1: 

Confirmed with the communications package.

A little further detail, the additional functions in oct-files are not returned by the following call:

>> list = __list_functions__ ("~/octave/communications-1.2.1/x86_64-unknown-linux-gnu-api-v50+")

I guess this function should be fixed to return the names of all functions in the directory, even multiple DEFUNs in oct-files.

Mike Miller <mtmiller>
Project Administrator
Thu 07 May 2015 03:33:54 PM UTC, original submission:  

When cache for documentation for a package is created (calling doc_cache_create), only the function named by the oct file gets his documentation created. The end result is that `lookfor` will not use autoloaded functions when searching the help text.

Example using the image package where searching for label should return both bwlabel and bwlabeln:

> pkg load image
> man bwlabel
[...]
 -- Loadable Function: [L, NUM] = bwlabel( BW)
 -- Loadable Function: [L, NUM] = bwlabel( BW, N)
     Label binary 2 dimensional image.
[...]
> man bwlabeln
[...]
 -- Loadable Function: [L, NUM] = bwlabeln (BW)
 -- Loadable Function: [L, NUM] = bwlabeln (BW, N)
     Label foreground objects in the n-dimensional binary image BW.
[...]
> lookfor label
clabel              Add labels to the contours of a contour plot.
datetick            Add date formatted tick labels to an axis.
legend              Display a legend for the current axes using the specified strings  as labels.
xlabel              Specify the string used to label the x-axis of the current axis.
ylabel              Specify the string used to label the y-axis of the current axis.
zlabel              Specify the string used to label the z-axis of the current axis.
label2rgb           Convert labeled image into RGB.
labelmatrix         Create labelled matrix from bwconncomp structure.
bwlabeln            Label foreground objects in the n-dimensional binary image BW.

Kudos to Olaf Till for finding this issue.

Carnë Draug <carandraug>
Project Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by mtmiller (Posted a comment)
  • -email is unavailable- added by carandraug (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only project members can vote.

     

     

     

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2015-05-10 mtmiller StatusNone Confirmed

    Back to the top

    Powered by Savane 3.9