[Octave-bug-tracker] [bug #39303] print_usage not working for some functions in signal Octave-Forge package

[Rik]

Follow-up Comment #7, bug #39303 (project octave):

The idea is that if your using the "plain text" help format then the first
line of your help text should be a Usage line.  In my old version of butter
from 1.0.11 the code is written like this:


  if (nargin>4 || nargin<2) || (nargout>4 || nargout<2)
    usage ("[b, a] or [z, p, g] or [a,b,c,d] = butter (n, W [,
'ftype'][,'s'])");
  end


In this case print_usage is never called.  Solution #1 would be to copy this
usage note and make it the first line of the butter.m help text like so


## Usage: [b, a] or [z, p, g] or [a,b,c,d] = butter (n, W [,
'ftype'][,'s'])\n
##\n


Solution #2 would be to stop using print_usage() and revert to usage().

Solution #3 would be to rewrite the documentation as a Texinfo, instead of
plain text, document.  This would be the best in the long run as Texinfo
produces nicer documentation in pdf and HTML format.


    _______________________________________________________

Reply to this item at:

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

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