[Octave-bug-tracker] [bug #61681] function documentation should always mention output if there is one

[Rik]

Update of bug #61681 (project octave):

                Severity:              3 - Normal => 1 - Wish               
                Priority:              5 - Normal => 3 - Low                
                  Status:                    None => Confirmed              
                 Summary: "help fftfilt" does not mention output => function
documentation should always mention output if there is one

    _______________________________________________________

Follow-up Comment #1:

I brought up this issue somewhere recently; maybe it was on Discourse.  Many
newbies to Octave don't understand that functions typically produce an output
even if it isn't stated.  For example, "help sind" starts with just "sind (X)"
and doesn't mention an output because it is understood.

I proposed that we be explicit, as Matlab does, and always list the output
when there is one.  So sind.m would become "Y = sind (X)".

fftfilt() is just another example of this general issue.  I think we should do
it, but it is a lot of work which is why it hasn't taken place yet.

    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?61681>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/