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:  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:  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.

../../run-octave -f -q -H -p ../../../octave/doc/interpreter --eval "splineimages ('splinefit6', 'txt');"
restore=: && backupdir=".am$$" && \
        am__cwd=`pwd` && CDPATH="${ZSH_VERSION+.}:" && cd ../../../octave/doc/interpreter && \
        rm -rf $backupdir && mkdir $backupdir && \
        if (/bin/bash /home/tatsuromatsuoka/work/Octave/develop/octave/build-aux/missing makeinfo --version) >/dev/null 2>&1; then \
          for f in ../../../octave/doc/interpreter/octave.info ../../../octave/doc/interpreter/octave.info-[0-9] ../../../octave/doc/interpreter/octave.info-[0-9][0-9] ../../../octave/doc/interpreter/octave.i[0-9] ../../../octave/doc/interpreter/octave.i[0-9][0-9]; do \
            if test -f $f; then mv $f $backupdir; restore=mv; else :; fi; \
          done; \
        else :; fi && \
        cd "$am__cwd"; \
        if /bin/bash /home/tatsuromatsuoka/work/Octave/develop/octave/build-aux/missing makeinfo   -I ../../../octave/doc/interpreter \
         -o ../../../octave/doc/interpreter/octave.info ../../../octave/doc/interpreter/octave.texi; \
        then \
          rc=0; \
          CDPATH="${ZSH_VERSION+.}:" && cd ../../../octave/doc/interpreter; \
        else \
          rc=$?; \
          CDPATH="${ZSH_VERSION+.}:" && cd ../../../octave/doc/interpreter && \
          $restore $backupdir/* `echo "./../../../octave/doc/interpreter/octave.info" | sed 's|[^/]*$||'`; \
        fi; \
        rm -rf $backupdir; exit $rc
./func.texi:773: must be after `@deftypefn' to use `@deftypefnx'
./func.texi:773: warning: missing name for @deftypefnx
./func.texi:776: must be after `@deftypefn' to use `@deftypefnx'
./func.texi:776: warning: missing name for @deftypefnx
./func.texi:779: must be after `@deftypefn' to use `@deftypefnx'
./func.texi:779: warning: missing name for @deftypefnx
./func.texi:783: must be after `@deftypefn' to use `@deftypefnx'
./func.texi:783: warning: missing name for @deftypefnx
./func.texi:786: must be after `@deftypefn' to use `@deftypefnx'
./func.texi:789: must be after `@deftypefn' to use `@deftypefnx'
./func.texi:792: must be after `@deftypefn' to use `@deftypefnx'
./func.texi:800: must be after `@deftypefn' to use `@deftypefnx'
make[3]: *** [../../../octave/doc/interpreter/octave.info] Error 1
make[3]: Leaving directory `/home/tatsuromatsuoka/work/Octave/develop/build/doc/interpreter'
make[2]: *** [all-recursive] Error 1
make[2]: Leaving directory `/home/tatsuromatsuoka/work/Octave/develop/build/doc'
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory `/home/tatsuromatsuoka/work/Octave/develop/build'
make: *** [all] Error 2

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 Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Digest:
   bug dependencies.

 

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

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

    Only project members can vote.

     

     

     

    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2019-06-02 siko1056 Dependencies- => bugs #56389 is dependent
    2016-12-09 amro_octave Carbon-Copy- => Added amro_octave
    2016-08-11 mtmiller Dependencies- => bugs #48682 is dependent
    2015-07-17 mtmiller Item GroupBuild Failure => Incorrect Result
        StatusNone => Confirmed
    2014-08-22 carandraug Operating SystemGNU/Linux => Any
        Summarybuild failure during making docimentation => help() does not see classdef files

    Back to the top


    Powered by Savane 3.5