Re: inputParser documentation

[Juan Pablo Carbajal]

On Wed, Mar 18, 2015 at 7:08 PM, Rik <address@hidden> wrote:

On 03/18/2015 09:00 AM, address@hidden wrote:

Subject:

inputParser documentation in 4.0

From:

Juan Pablo Carbajal <address@hidden>

Date:

03/18/2015 02:06 AM

To:

Maintainers GNU Octave <address@hidden>

List-Post:

<mailto:address@hidden>

Content-Transfer-Encoding:

quoted-printable

Precedence:

list

MIME-Version:

1.0

Message-ID:

<address@hidden>

Content-Type:

text/plain; charset=UTF-8

Message:

5

Hi,

Carnë already mentioned that "help inputParser" doesn't work correctly.
However the help for the constructor appears in the manual.

I wonder if this is also related to the behavior of which()?

octave:1> which inputParser
'inputParser' is a built-in function
octave:2> which sin
'sin' is a built-in function from the file libinterp/corefcn/mappers.cc
octave:3> which inputParser.m
'inputParser.m' is the file /home/rik/wip/Projects_Mine/octave-dev/scripts/general/inputParser.m
octave:4> which sind
'sind' is a function from the file /home/rik/wip/Projects_Mine/octave-dev/scripts/elfun/sind.m

The first line does not look correct.

Where in the manual is the help for the methods?
The see aslo section should include links to those.

I don't think we have a solution yet for classdef files and documentation.  Previously, every m-file had a single texinfo block at the top that was parsed.  If you were using the old class syntax, then every method was also it's own m-file in a @classname directory.  This is how the @ftp class works and if you look at system.txi there is a DOCSTRING entry for each m-file.  We might not figure a solution to this before the 4.0 release.

--Rik

Will we have "undocumented" documented functionality? documentation that can only be accessed through the source code?

So to read the help one should do type <file>?

Is there no way to getting this help, at least in to the online manual?

I find this a rather serious problem.