|
From: | Paul Kienzle |
Subject: | Re: file-io docstrings |
Date: | Sat, 4 Dec 2004 00:40:53 -0500 |
On Dec 3, 2004, at 9:30 AM, John W. Eaton wrote:
In most places, if a function only returns one value, the docstrings have @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. Comments?
Some routines don't return values, and some routines do different things if a value is returned than if one isn't. I'm not convinced this is enough of a reason to increase the clutter on in the documentation though. - Paul
[Prev in Thread] | Current Thread | [Next in Thread] |