From maintainers-request at octave dot org Fri Dec  3 08:29:26 2004
Subject: file-io docstrings
From: "John W. Eaton" <jwe at bevo dot che dot wisc dot edu>
To: Teemu Ikonen <tpikonen at pcu dot helsinki dot fi>
Cc: maintainers at octave dot org
Date: Fri, 3 Dec 2004 09:30:52 -0500

On  3-Dec-2004, Teemu Ikonen <tpikonen at pcu dot helsinki dot fi> wrote:

| I made some cleanups to the documentation strings on functions defined on
| file-io.cc. A patch is attached.

I applied this patch, with a few minor changes.

In most places, if a function only returns one value, the docstrings
have

   at deftypefn {Built-in Function} {} fflush (@var{fid})\n\

instead of

   at deftypefn {Built-in Function} {} @var{status} = fflush (@var{fid})\n\

as in your changes, so I removed the " at var{status} = ".  But we should
decide what the convention should really be.  I think it clutters the
docs to have the return values listed by name when there is only one,
but maybe others would prefer to see them.

Comments?

jwe