bugGNU Octave - Bugs: bug #43047, help() does not see classdef files

 
 

bug #43047: help() does not see classdef files

Submitted by:  Tatsuro MATSUOKA <tmacchant>
Submitted on:  Fri 22 Aug 2014 12:03:16 AM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Incorrect Result
Status: ConfirmedAssigned to: None
Originator Name: Open/Closed: Open
Release: devOperating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Fri 17 Jul 2015 01:54:18 PM UTC, comment #2:

I haven't seen this error with the build, I don't think this is still a "build failure" item. Specficially, inputParser does show up in the manual even though the "help" function doesn't find it.

So "help inputParser" fails but "doc inputParser" works.

Mike Miller <mtmiller>
Project Administrator
Fri 22 Aug 2014 12:17:49 AM UTC, comment #1:

The problem is the new class 'inputParser' which is a classdef class and not a normal function.

Although the class is documented, it seems to fail to recognize it. This is the first classdef function in Octave so there's kinks like that which need to be ironed. Because the docstring should be included in the manual, this causes the documentation build to fail.

Note that the error message is incorrect. The message says "'inputParser' is not documented" but it is. The bug seems to come from get_help_text() which does not recognize it as such and returns "not documented".

Carnë Draug <carandraug>
Project Member
Fri 22 Aug 2014 12:03:16 AM UTC, original submission:

I have check out the development source yesterday (21 Aug., 2014).
and tried to build.

The build failed during making docimentation.

Any suggestions?

I am using Ubuntu 14.04 LTS amd64. GCC version is 4.8.2.

Tatsuro

Tatsuro MATSUOKA <tmacchant>

 

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

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Digest:
   bug dependencies.

 

Carbon-Copy List
  • -unavailable- added by amro_octave
  • -unavailable- added by mtmiller (Posted a comment)
  • -unavailable- added by tmacchant (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 6 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Fri 09 Dec 2016 11:34:14 PM UTCamro_octaveCarbon-Copy-=>Added amro_octave
    Thu 11 Aug 2016 05:51:44 AM UTCmtmillerDependencies-=>bugs #48682 is dependent
    Fri 17 Jul 2015 01:54:18 PM UTCmtmillerItem GroupBuild Failure=>Incorrect Result
      StatusNone=>Confirmed
    Fri 22 Aug 2014 12:17:49 AM UTCcarandraugOperating SystemGNU/Linux=>Any
      Summarybuild failure during making docimentation =>help() does not see classdef files

    Back to the top


    Powered by Savane 3.1-cleanup1