changeset 43414:90f3a1f6ee84

(Math Functions): Document the optional second arg of atan.
author Eli Zaretskii <eliz@gnu.org>
date Tue, 19 Feb 2002 11:03:54 +0000
parents 0f448bd1bf9a
children 59c97b8695ee
files lispref/numbers.texi
diffstat 1 files changed, 6 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/numbers.texi	Tue Feb 19 10:58:07 2002 +0000
+++ b/lispref/numbers.texi	Tue Feb 19 11:03:54 2002 +0000
@@ -1046,8 +1046,8 @@
 is out of range (outside [-1, 1]), then the result is a NaN.
 @end defun
 
-@defun atan arg
-The value of @code{(atan @var{arg})} is a number between
+@defun atan y &optional x
+The value of @code{(atan @var{y})} is a number between
 @ifnottex
 @minus{}pi/2
 @end ifnottex
@@ -1061,7 +1061,10 @@
 @tex
 @math{\pi/2}
 @end tex
-(exclusive) whose tangent is @var{arg}.
+(exclusive) whose tangent is @var{y}.  If the optional second
+argument @var{x} is given, the value of @code{(atan y x)} is the
+angle in radians between the vector @code{[@var{x}, @var{y}]} and the
+@code{X} axis.
 @end defun
 
 @defun exp arg