[Top][All Lists]

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

file-io docstrings

From: John W. Eaton
Subject: file-io docstrings
Date: Fri, 3 Dec 2004 09:30:52 -0500

On  3-Dec-2004, Teemu Ikonen <address@hidden> 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

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

instead of

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

as in your changes, so I removed the "@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.



reply via email to

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