[gnumeric] docs: propagate recent changes.
- From: Morten Welinder <mortenw src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnumeric] docs: propagate recent changes.
- Date: Sun, 30 May 2010 18:35:56 +0000 (UTC)
commit f3ced5545a72eae19de3d5e96b0526e4b98746ac
Author: Morten Welinder <terra gnome org>
Date: Sun May 30 14:35:40 2010 -0400
docs: propagate recent changes.
doc/C/func.defs | 59 ++++++++++++++++++++++---------------------
doc/C/functions.xml | 69 ++++++++++++++++++++------------------------------
2 files changed, 58 insertions(+), 70 deletions(-)
---
diff --git a/doc/C/func.defs b/doc/C/func.defs
index 574f03d..3ce1751 100644
--- a/doc/C/func.defs
+++ b/doc/C/func.defs
@@ -2959,7 +2959,7 @@ If any argument is zero, the result is zero.
@ARGUMENTDESCRIPTION= {x}: number
@DESCRIPTION=ABS gives the absolute value of @{x}, i.e. the non-negative number of the same magnitude as @{x}.
@EXCEL=This function is Excel compatible.
- SEEALSO=CEIL, CEILING, FLOOR, INT, MOD
+ SEEALSO=CEIL,CEILING,FLOOR,INT,MOD
@CATEGORY=Mathematics
@FUNCTION=ACOS
@@ -2967,7 +2967,7 @@ If any argument is zero, the result is zero.
@SYNTAX=ACOS(x)
@ARGUMENTDESCRIPTION= {x}: number
@EXCEL=This function is Excel compatible.
- SEEALSO=COS, SIN, DEGREES, RADIANS
+ SEEALSO=COS,SIN,DEGREES,RADIANS
@CATEGORY=Mathematics
@FUNCTION=ACOSH
@@ -2975,7 +2975,7 @@ If any argument is zero, the result is zero.
@SYNTAX=ACOSH(x)
@ARGUMENTDESCRIPTION= {x}: number
@EXCEL=This function is Excel compatible.
- SEEALSO=ACOS,ASINH,DEGREES,RADIANS
+ SEEALSO=ACOS,ASINH
@CATEGORY=Mathematics
@FUNCTION=ACOT
@@ -3017,36 +3017,37 @@ If any argument is zero, the result is zero.
@ARGUMENTDESCRIPTION= {x}: number
@DESCRIPTION=ASINH calculates the inverse hyperbolic sine of @{x}; that is the value whose hyperbolic sine is @{x}.
@EXCEL=This function is Excel compatible.
- SEEALSO=ASIN,ACOSH,SIN,COS,DEGREES,RADIANS
+ SEEALSO=ASIN,ACOSH,SIN,COS
@CATEGORY=Mathematics
@FUNCTION=ATAN
@SHORTDESC=the arc tangent of @{x}
@SYNTAX=ATAN(x)
- ARGUMENTDESCRIPTION=@{x}: angle in radians
+ ARGUMENTDESCRIPTION=@{x}: number
@DESCRIPTION=ATAN calculates the arc tangent of @{x}; that is the value whose tangent is @{x}.
@EXCEL=This function is Excel compatible.
@SEEALSO=TAN,COS,SIN,DEGREES,RADIANS
@CATEGORY=Mathematics
@FUNCTION=ATAN2
- SHORTDESC=arc tangent of the ratio of @{b1} and @{b2}
- SYNTAX=ATAN2(b1,b2)
- ARGUMENTDESCRIPTION=@{b1}: angle in radians
- {b2}: angle in radians
- DESCRIPTION=ATAN2 calculates the arc tangent of the ratio @{b1}/@{b2} with the sign according to the quadrant containing (@{b1},@{b2}).
+ SHORTDESC=arc tangent of the ratio of @{y} and @{x}
+ SYNTAX=ATAN2(y,x)
+ ARGUMENTDESCRIPTION=@{y}: y-coordinate
+ {x}: x-coordinate
+ DESCRIPTION=ATAN2 calculates the direction from the origin to (@{x},@{y}) as an angle in radians.
+ NOTE=The result will be between Ï? and +Ï?. The order of the arguments may be unexpected.
@EXCEL=This function is Excel compatible.
- SEEALSO=ATAN,ATANH,COS,SIN,DEGREES,RADIANS
+ SEEALSO=ATAN,ATANH,COS,SIN
@CATEGORY=Mathematics
@FUNCTION=ATANH
@SHORTDESC=the inverse hyperbolic tangent of @{x}
@SYNTAX=ATANH(x)
- ARGUMENTDESCRIPTION=@{x}: angle in radians
+ ARGUMENTDESCRIPTION=@{x}: number
@DESCRIPTION=ATANH calculates the inverse hyperbolic tangent of @{x}; that is the value whose hyperbolic tangent is @{x}.
@NOTE=If the absolute value of @{x} is greater than 1.0, ATANH returns #NUM!
@EXCEL=This function is Excel compatible.
- SEEALSO=ATAN,COS,SIN,DEGREES,RADIANS
+ SEEALSO=ATAN,COS,SIN
@CATEGORY=Mathematics
@FUNCTION=AVERAGEIF
@@ -3139,9 +3140,9 @@ If any argument is zero, the result is zero.
@FUNCTION=COSH
@SHORTDESC=Hyperbolic cosine function
@SYNTAX=COSH(x)
- ARGUMENTDESCRIPTION=@{x}: angle in radians
+ ARGUMENTDESCRIPTION=@{x}: number
@EXCEL=This function is Excel compatible.
- SEEALSO=SIN,TAN,SINH,COSH,TANH,RADIANS,DEGREES
+ SEEALSO=SIN,TAN,SINH,COSH,TANH
@CATEGORY=Mathematics
@FUNCTION=COT
@@ -3179,10 +3180,10 @@ If any argument is zero, the result is zero.
@FUNCTION=CSCH
@SHORTDESC=Hyperbolic cosecant
@SYNTAX=CSCH(x)
- ARGUMENTDESCRIPTION=@{x}: angle in radians
+ ARGUMENTDESCRIPTION=@{x}: number
@EXCEL=This function is not Excel compatible.
@ODF=This function is OpenFormula compatible.
- SEEALSO=SIN,COS,TAN,CSC,SEC,SINH,COSH,TANH,RADIANS,DEGREES
+ SEEALSO=SIN,COS,TAN,CSC,SEC,SINH,COSH,TANH
@CATEGORY=Mathematics
@FUNCTION=DEGREES
@@ -3214,7 +3215,7 @@ If any argument is zero, the result is zero.
@ARGUMENTDESCRIPTION= {x}: number
@NOTE=e is the base of the natural logarithm.
@EXCEL=This function is Excel compatible.
- SEEALSO=LOG, LOG2, LOG10
+ SEEALSO=LOG,LOG2,LOG10
@CATEGORY=Mathematics
@FUNCTION=EXPM1
@@ -3222,7 +3223,7 @@ If any argument is zero, the result is zero.
@SYNTAX=EXPM1(x)
@ARGUMENTDESCRIPTION= {x}: number
@NOTE=This function has a higher resulting precision than evaluating EXP(@{x})-1.
- SEEALSO=EXP, LN1P
+ SEEALSO=EXP,LN1P
@CATEGORY=Mathematics
@FUNCTION=FACT
@@ -3268,7 +3269,7 @@ If any argument is zero, the result is zero.
@ARGUMENTDESCRIPTION= {x1}: number
@{x2}: number
@NOTE=Empty cells are ignored and the empty product is 1.
- SEEALSO=SUM, COUNT
+ SEEALSO=SUM,COUNT
@CATEGORY=Mathematics
@FUNCTION=GAMMA
@@ -3381,7 +3382,7 @@ If any argument is zero, the result is zero.
@SYNTAX=MDETERM(matrix)
@ARGUMENTDESCRIPTION= {matrix}: a square matrix
@EXCEL=This function is Excel compatible.
- SEEALSO=MMULT, MINVERSE
+ SEEALSO=MMULT,MINVERSE
@CATEGORY=Mathematics
@FUNCTION=MINVERSE
@@ -3390,7 +3391,7 @@ If any argument is zero, the result is zero.
@ARGUMENTDESCRIPTION= {matrix}: a square matrix
@NOTE=If @{matrix} is not invertible, MINVERSE returns #NUM! If @{matrix} does not contain an equal number of columns and rows, MINVERSE returns #VALUE!
@EXCEL=This function is Excel compatible.
- SEEALSO=MMULT, MDETERM
+ SEEALSO=MMULT,MDETERM
@CATEGORY=Mathematics
@FUNCTION=MMULT
@@ -3555,10 +3556,10 @@ If @{d} is less than zero, @{x} is rounded away from 0 to the left of the decima
@FUNCTION=SECH
@SHORTDESC=Hyperbolic secant
@SYNTAX=SECH(x)
- ARGUMENTDESCRIPTION=@{x}: angle in radians
+ ARGUMENTDESCRIPTION=@{x}: number
@EXCEL=This function is not Excel compatible.
@ODF=SECH(@{x}) is exported to OpenFormula as 1/COSH(@{x}).
- SEEALSO=SIN,COS,TAN,CSC,SEC,SINH,COSH,TANH,RADIANS,DEGREES
+ SEEALSO=SIN,COS,TAN,CSC,SEC,SINH,COSH,TANH
@CATEGORY=Mathematics
@FUNCTION=SERIESSUM
@@ -3592,9 +3593,9 @@ If @{d} is less than zero, @{x} is rounded away from 0 to the left of the decima
@FUNCTION=SINH
@SHORTDESC=the hyperbolic sine of @{x}
@SYNTAX=SINH(x)
- ARGUMENTDESCRIPTION=@{x}: angle in radians
+ ARGUMENTDESCRIPTION=@{x}: number
@EXCEL=This function is Excel compatible.
- SEEALSO=ACOS,ASINH,DEGREES,RADIANS
+ SEEALSO=SIN,COSH,ASINH
@CATEGORY=Mathematics
@FUNCTION=SQRT
@@ -3652,7 +3653,7 @@ If @{d} is less than zero, @{x} is rounded away from 0 to the left of the decima
@CATEGORY=Mathematics
@FUNCTION=SUMSQ
- SHORTDESC=sum of th squares of all values and cells referenced
+ SHORTDESC=sum of the squares of all values and cells referenced
@SYNTAX=SUMSQ(area0,area1)
@ARGUMENTDESCRIPTION= {area0}: first cell area
@{area1}: second cell area
@@ -3705,9 +3706,9 @@ Strings and empty cells are simply ignored.
@FUNCTION=TANH
@SHORTDESC=hyperbolic tangent
@SYNTAX=TANH(x)
- ARGUMENTDESCRIPTION=@{x}: angle in radians
+ ARGUMENTDESCRIPTION=@{x}: number
@EXCEL=This function is Excel compatible.
- SEEALSO=TAN, SIN, SINH, COS, COSH, DEGREES, RADIANS
+ SEEALSO=TAN,SIN,SINH,COS,COSH
@CATEGORY=Mathematics
@FUNCTION=TRUNC
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index 12aeb8c..d44a396 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -9816,9 +9816,7 @@
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ACOS"><function>ACOS</function></link>,
- <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ <link linkend="gnumeric-ASINH"><function>ASINH</function></link>.
</para>
</refsect1>
</refentry>
@@ -9990,9 +9988,7 @@
<para><link linkend="gnumeric-ASIN"><function>ASIN</function></link>,
<link linkend="gnumeric-ACOSH"><function>ACOSH</function></link>,
<link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ <link linkend="gnumeric-COS"><function>COS</function></link>.
</para>
</refsect1>
</refentry>
@@ -10015,7 +10011,7 @@
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>x</parameter>: angle in radians</para>
+ <para><parameter>x</parameter>: number</para>
</refsect1>
<refsect1>
<title>Description</title>
@@ -10046,20 +10042,24 @@
<function>ATAN2</function>
</refname>
<refpurpose>
- arc tangent of the ratio of <parameter>b1</parameter> and <parameter>b2</parameter>
+ arc tangent of the ratio of <parameter>y</parameter> and <parameter>x</parameter>
</refpurpose>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ATAN2</function>(<parameter>b1</parameter>,<parameter>b2</parameter>)</synopsis>
+ <synopsis><function>ATAN2</function>(<parameter>y</parameter>,<parameter>x</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>b1</parameter>: angle in radians</para>
- <para><parameter>b2</parameter>: angle in radians</para>
+ <para><parameter>y</parameter>: y-coordinate</para>
+ <para><parameter>x</parameter>: x-coordinate</para>
</refsect1>
<refsect1>
<title>Description</title>
- <para><function>ATAN2</function> calculates the arc tangent of the ratio <parameter>b1</parameter>/<parameter>b2</parameter> with the sign according to the quadrant containing (<parameter>b1</parameter>,<parameter>b2</parameter>).</para>
+ <para><function>ATAN2</function> calculates the direction from the origin to (<parameter>x</parameter>,<parameter>y</parameter>) as an angle in radians.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The result will be between Ï? and +Ï?. The order of the arguments may be unexpected.</para>
</refsect1>
<refsect1>
<title>Microsoft Excel Compatibility</title>
@@ -10070,9 +10070,7 @@
<para><link linkend="gnumeric-ATAN"><function>ATAN</function></link>,
<link linkend="gnumeric-ATANH"><function>ATANH</function></link>,
<link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>.
</para>
</refsect1>
</refentry>
@@ -10095,7 +10093,7 @@
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>x</parameter>: angle in radians</para>
+ <para><parameter>x</parameter>: number</para>
</refsect1>
<refsect1>
<title>Description</title>
@@ -10113,9 +10111,7 @@
<title>See also</title>
<para><link linkend="gnumeric-ATAN"><function>ATAN</function></link>,
<link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>.
</para>
</refsect1>
</refentry>
@@ -10474,7 +10470,7 @@
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>x</parameter>: angle in radians</para>
+ <para><parameter>x</parameter>: number</para>
</refsect1>
<refsect1>
<title>Microsoft Excel Compatibility</title>
@@ -10486,9 +10482,7 @@
<link linkend="gnumeric-TAN"><function>TAN</function></link>,
<link linkend="gnumeric-SINH"><function>SINH</function></link>,
<link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
</para>
</refsect1>
</refentry>
@@ -10643,7 +10637,7 @@
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>x</parameter>: angle in radians</para>
+ <para><parameter>x</parameter>: number</para>
</refsect1>
<refsect1>
<title>Microsoft Excel Compatibility</title>
@@ -10662,9 +10656,7 @@
<link linkend="gnumeric-SEC"><function>SEC</function></link>,
<link linkend="gnumeric-SINH"><function>SINH</function></link>,
<link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
</para>
</refsect1>
</refentry>
@@ -12080,7 +12072,7 @@
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>x</parameter>: angle in radians</para>
+ <para><parameter>x</parameter>: number</para>
</refsect1>
<refsect1>
<title>Microsoft Excel Compatibility</title>
@@ -12099,9 +12091,7 @@
<link linkend="gnumeric-SEC"><function>SEC</function></link>,
<link linkend="gnumeric-SINH"><function>SINH</function></link>,
<link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
</para>
</refsect1>
</refentry>
@@ -12233,7 +12223,7 @@
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>x</parameter>: angle in radians</para>
+ <para><parameter>x</parameter>: number</para>
</refsect1>
<refsect1>
<title>Microsoft Excel Compatibility</title>
@@ -12241,10 +12231,9 @@
</refsect1>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-ACOS"><function>ACOS</function></link>,
- <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-ASINH"><function>ASINH</function></link>.
</para>
</refsect1>
</refentry>
@@ -12466,7 +12455,7 @@
<function>SUMSQ</function>
</refname>
<refpurpose>
- sum of th squares of all values and cells referenced
+ sum of the squares of all values and cells referenced
</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -12666,7 +12655,7 @@
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
- <para><parameter>x</parameter>: angle in radians</para>
+ <para><parameter>x</parameter>: number</para>
</refsect1>
<refsect1>
<title>Microsoft Excel Compatibility</title>
@@ -12678,9 +12667,7 @@
<link linkend="gnumeric-SIN"><function>SIN</function></link>,
<link linkend="gnumeric-SINH"><function>SINH</function></link>,
<link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>.
</para>
</refsect1>
</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]