Mercurial > hg > octave-lyh

diff scripts/general/rem.m @ 3321:6923abb04e16
[project @ 1999-10-26 18:15:30 by jwe]
author: jwe
date: Tue, 26 Oct 1999 18:15:41 +0000
parents: 8b262e771614
children: 5e0a0b1cba43
--- a/scripts/general/rem.m
+++ b/scripts/general/rem.m
@@ -17,9 +17,20 @@
 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-## usage: rem (x, y)
-##
-## Return remainder (x, y).
+## -*- texinfo -*-
+## @deftypefn {Mapping Function} {} rem (@var{x}, @var{y})
+## Return the remainder of @code{@var{x} / @var{y}}, computed using the
+## expression
+## 
+## @example
+## x - y .* fix (x ./ y)
+## @end example
+## 
+## An error message is printed if the dimensions of the arguments do not
+## agree, or if either of the arguments is complex.
+## @end deftypefn
+
+## See also: round
 
 ## Author: jwe