Bug in dlmwrite.m (patch attached)

[David Bateman]

Matt Foster wrote:
> On Mon, Jun 23, 2008 at 12:50 PM, David Bateman
> <David.Bateman at motorola.com> wrote:
>   
>> http://www.mathworks.com/access/helpdesk/help/techdoc/index.html?/access/helpdesk/help/techdoc/ref/dlmwrite.html
>>
>> "delim" is not documented as a valid option to dlmwrite for matlab and
>> so I don't see this as compatibility issue. Sure we might accept "delim"
>> as well, but is it necessary?
>>
>>     
>
> It's probably not necessary, but it is listed at the top of the function's help.
>   

No "delim" in the help text of the function is a variable as in texinfo
its flagged as "@var{delim}", and its the means of passing the delimiter
without defining what the option type is. That is

dlmwrite (file, a, "\t")

is the same as

dlmwrite (file, a, "delimiter", "\t")

The use of @var{} is a standard convention in Octave help strings to
define the difference between a variable and an option string.

D.


-- 
David Bateman                                David.Bateman at motorola.com
Motorola Labs - Paris                        +33 1 69 35 48 04 (Ph) 
Parc Les Algorithmes, Commune de St Aubin    +33 6 72 01 06 33 (Mob) 
91193 Gif-Sur-Yvette FRANCE                  +33 1 69 35 77 01 (Fax) 

The information contained in this communication has been classified as: 

[x] General Business Information 
[ ] Motorola Internal Use Only 
[ ] Motorola Confidential Proprietary