Mercurial > octave-nkf

changeset 13138:5a3983cb9912 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Mention roundb in round's docstring
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Wed, 14 Sep 2011 23:25:33 -0500
parents d049192e5d15
children ab17591254fc
files src/mappers.cc
diffstat 1 files changed, 3 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/mappers.cc	Sun Sep 11 12:38:23 2011 -0500
+++ b/src/mappers.cc	Wed Sep 14 23:25:33 2011 -0500
@@ -1475,7 +1475,8 @@
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} round (@var{x})\n\
 Return the integer nearest to @var{x}.  If @var{x} is complex, return\n\
-@code{round (real (@var{x})) + round (imag (@var{x})) * I}.\n\
+@code{round (real (@var{x})) + round (imag (@var{x})) * I}. If there\n\
+are two nearest integers, return the one further away from zero.\n\
 \n\
 @example\n\
 @group\n\
@@ -1483,7 +1484,7 @@
      @result{} -3   3\n\
 @end group\n\
 @end example\n\
-@seealso{ceil, floor, fix}\n\
+@seealso{ceil, floor, fix, roundb}\n\
 @end deftypefn")
 {
   octave_value retval;