[Octave-bug-tracker] [bug #46821] cumsum: output variables not documented

[Rik]

Follow-up Comment #6, bug #46821 (project octave):

Adding a return variable declaration to the documentation for functions which
return only a single variable would, arguably, be slightly clearer.  Not that
we have to be slavish to Matlab, but this is what they do.

On the other hand, I do agree with jwe that it clutters the documentation.  I
think, most importantly, is that this is opposite to the convention we have
been using.  Rather than have this *one* docstring be different from the rest,
I would code it without the return variable.

If we want to change the documentation over to universally have a return value
we should do so in just one changeset.  This should only be after discussion
on the Maintainer's list.  Right now I would probably vote against changing it
because it means a lot of work, for a small gain.  If someone has 8 hours to
work on Octave, I can see other projects that I would have them do first.




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?46821>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/