help-octave
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: isa strangeness


From: Francesco Potortì
Subject: Re: isa strangeness
Date: Mon, 16 Aug 2010 18:29:55 +0200

Martin Helm:
>
>> The help string of isa is not really good here.

Jaroslav Hajek:
>On the contrary, I think that the help string is OK, It's just that
>Richard doesn't understand the fundamentals of Octave syntax; but we
>surely can't repeat those in every docstring, can we?

Mh.  The help string in 3.2 is:

 -- Function File:  isa (X, CLASS)
     Return true if X is a value from the class CLASS.

While this may be good as a help string (and even there an example would
help, as suggested on the list), it is too terse for a manual.  Even if
I look for 'class' in the index, the only match is that same page, where
no description is found of what is a CLASS.  Nor can one find a
reference to some place where what is a CLASS is explained.

Maybe the cure should be to put an explanation of what a CLASS is at the
beginning of that page, together with examples of usage of the
subsequent functions.

-- 
Francesco Potortì (ricercatore)        Voice: +39 050 315 3058 (op.2111)
ISTI - Area della ricerca CNR          Fax:   +39 050 315 2040
via G. Moruzzi 1, I-56124 Pisa         Email: address@hidden
(entrance 20, 1st floor, room C71)     Web:   http://fly.isti.cnr.it/


reply via email to

[Prev in Thread] Current Thread [Next in Thread]