octave-bug-tracker
[Top][All Lists]
Advanced

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

[Octave-bug-tracker] [bug #51997] Missing documentation of return value


From: Rik
Subject: [Octave-bug-tracker] [bug #51997] Missing documentation of return value of warning()
Date: Wed, 13 Sep 2017 19:21:53 -0400 (EDT)
User-agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:55.0) Gecko/20100101 Firefox/55.0

Follow-up Comment #4, bug #51997 (project octave):

>From the results in comment #3, it seems Octave is Matlab compatible.

In terms of updating the documentation, I would prefer to see the explicit
forms,


@deftypefnx {} {} warning ("on", @var{id})
@deftypefnx {} {} warning ("off", @var{id})
@deftypefnx {} {} warning ("query", @var{id})
@deftypefnx {} {} warning ("error", @var{id})


rather than just 


@deftypefnx {} {} warning (@var{state})


with an explanation of state deeper in the documentation.  Most people reading
the documentation are trying to figure out how to use the function with the
minimum amount of research necessary.  If you provide the standard calling
forms in the function summary it is often unnecessary to read any further
which is quite helpful. 


    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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