GNOME.org
 

[gnumeric] docs: fix argument references.

commit 9979459d0cb2a11ac787af74eb194a96e383327b
Author: Morten Welinder <terra gnome org>
Date:   Wed Sep 1 14:56:49 2010 -0400

    docs: fix argument references.

 NEWS                          |    1 +
 doc/C/func.defs               |   33 +++++++++++++++----------
 doc/C/functions.xml           |   53 +++++++++++++++++++++++++++++++---------
 plugins/fn-eng/functions.c    |    2 +-
 plugins/fn-info/functions.c   |    2 +-
 plugins/fn-lookup/functions.c |    8 +++---
 plugins/fn-stat/functions.c   |    2 +-
 7 files changed, 69 insertions(+), 32 deletions(-)
---
diff --git a/NEWS b/NEWS
index ab85b14..fe052ae 100644
--- a/NEWS
+++ b/NEWS
@@ -22,6 +22,7 @@ Morten:
 	* Fix elapsed-time entry.  [#628082]
 	* Fix problems with limits for date axes.
 	* Improve function docs self test.
+	* Fix errors in function docs.
 
 --------------------------------------------------------------------------
 Gnumeric 1.10.9
diff --git a/doc/C/func.defs b/doc/C/func.defs
index 15e97e5..c73b64f 100644
--- a/doc/C/func.defs
+++ b/doc/C/func.defs
@@ -1162,7 +1162,7 @@ For metric units any of the following prefixes can be used:
 @SHORTDESC=decimal representation of @{x}
 @SYNTAX=DECIMAL(x,base)
 @ARGUMENTDESCRIPTION= {x}: number in base @{base}
- {base}: base of @{x}, (2 â?¤ @{b} â?¤ 36)
+ {base}: base of @{x}, (2 â?¤ @{base} â?¤ 36)
 @ODF=This function is OpenFormula compatible.
 @SEEALSO=BASE
 
@@ -1373,6 +1373,14 @@ Otherwise ACCRINT returns the sum of the interest accrued in all coupon periods
 @SEEALSO=AMORDEGRC
 
 @CATEGORY=Finance
+ FUNCTION=ATL_LAST
+ SHORTDESC=sample real-time data source
+ SYNTAX=ATL_LAST(tag)
+ ARGUMENTDESCRIPTION=@{tag}: tag to watch
+ DESCRIPTION=ATL_LAST is a sample implementation of a real time data source.  It takes a string tag and monitors the named pipe ~/atl for changes to the value of that tag.
+ NOTE=This is not intended to be generally enabled and is OFF by default.
+
+ CATEGORY=Finance
 @FUNCTION=COUPDAYBS
 @SHORTDESC=number of days from coupon period to settlement
 @SYNTAX=COUPDAYBS(settlement,maturity,frequency,basis,eom)
@@ -2706,7 +2714,7 @@ Otherwise ACCRINT returns the sum of the interest accrued in all coupon periods
 @SHORTDESC=a number indicating the data type of @{value}
 @SYNTAX=TYPE(value)
 @ARGUMENTDESCRIPTION= {value}: a value
- DESCRIPTION=TYPE returns a number indicating the data type of @{ value}:
+ DESCRIPTION=TYPE returns a number indicating the data type of @{value}:
 1  	= number
 2  	= text
 4  	= boolean
@@ -2842,8 +2850,8 @@ Otherwise ACCRINT returns the sum of the interest accrued in all coupon periods
 @SHORTDESC=vector of column numbers
 @SYNTAX=COLUMN(x)
 @ARGUMENTDESCRIPTION= {x}: reference, defaults to the position of the current expression
- DESCRIPTION=COLUMN function returns a Nx1 array containing the sequence of integers from the first column to the last column of @{reference}.
- NOTE=If @{reference} is neither an array nor a reference nor a range, returns #VALUE!
+ DESCRIPTION=COLUMN function returns a Nx1 array containing the sequence of integers from the first column to the last column of @{x}.
+ NOTE=If @{x} is neither an array nor a reference nor a range, returns #VALUE!
 @SEEALSO=COLUMNS,ROW,ROWS
 
 @CATEGORY=Lookup
@@ -2943,8 +2951,8 @@ Otherwise ACCRINT returns the sum of the interest accrued in all coupon periods
 @SHORTDESC=vector of row numbers
 @SYNTAX=ROW(x)
 @ARGUMENTDESCRIPTION= {x}: reference, defaults to the position of the current expression
- DESCRIPTION=ROW function returns a 1xN array containing the sequence of integers from the first row to the last row of @{reference}.
- NOTE=If @{reference} is neither an array nor a reference nor a range, returns #VALUE!
+ DESCRIPTION=ROW function returns a 1xN array containing the sequence of integers from the first row to the last row of @{x}.
+ NOTE=If @{x} is neither an array nor a reference nor a range, returns #VALUE!
 @SEEALSO=COLUMN,COLUMNS,ROWS
 
 @CATEGORY=Lookup
@@ -4350,7 +4358,7 @@ The successive use of the simulation tool also requires that you give to the too
 
 @CATEGORY=Statistics
 @FUNCTION=EXPONDIST
- SHORTDESC=porbaility density or cumulative distribution function of the exponential distribution
+ SHORTDESC=probability density or cumulative distribution function of the exponential distribution
 @SYNTAX=EXPONDIST(x,y,cumulative)
 @ARGUMENTDESCRIPTION= {x}: number
 @{y}: scale parameter
@@ -4433,7 +4441,7 @@ The successive use of the simulation tool also requires that you give to the too
 @ARGUMENTDESCRIPTION= {data_array}: data values
 @{bins_array}: array of cutoff values
 @DESCRIPTION=The results are given as an array.
-If the @{bin_array} is empty, this function returns the number of data points in @{data_array}.
+If the @{bins_array} is empty, this function returns the number of data points in @{data_array}.
 @EXCEL=This function is Excel compatible.
 
 @CATEGORY=Statistics
@@ -6112,12 +6120,11 @@ The output consists always of one column of complex numbers.
 @FUNCTION=INTERPOLATION
 @SHORTDESC=interpolated values corresponding to the given abscissa targets
 @SYNTAX=INTERPOLATION(abscissae,ordinates,targets,interpolation)
- ARGUMENTDESCRIPTION=@{abscissae}: abscissae of the given data points
+ ARGUMENTDESCRIPTION=@{abscissae}: ordered abscissae of the given data points
 @{ordinates}: ordinates of the given data points
 @{targets}: abscissae of the interpolated data
- {interpolation}: method of interpolation, defaults to none
- DESCRIPTION=If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.
-The output consists always of one column of numbers.
+ {interpolation}: method of interpolation, defaults to 0 ('linear')
+ DESCRIPTION=The output consists always of one column of numbers.
 Possible interpolation methods are:
 0: linear;
 1: linear with averaging;
@@ -6125,7 +6132,7 @@ Possible interpolation methods are:
 3: staircase with averaging;
 4: natural cubic spline;
 5: natural cubic spline with averaging.
- NOTE=Strings and empty cells in @{abscissae} and @{ordinates} are ignored. If several target data are provided they must be in the same column in consecutive cells.
+ NOTE=The @{abscissae} must be given in increasing order. If any of interpolation methods 1 ('linear with averaging'), 3 ('staircase with averaging'), and 5 ('natural cubic spline with averaging') is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order. Strings and empty cells in @{abscissae} and @{ordinates} are ignored. If several target data are provided they must be in the same column in consecutive cells.
 @SEEALSO=PERIODOGRAM
 
 @CATEGORY=Time Series Analysis
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index a56f6b8..c47f522 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -4038,7 +4038,7 @@
       <refsect1>
         <title>Arguments</title>
         <para><parameter>x</parameter>: number in base <parameter>base</parameter></para>
-        <para><parameter>base</parameter>: base of <parameter>x</parameter>, (2 â?¤ <parameter>b</parameter> â?¤ 36)</para>
+        <para><parameter>base</parameter>: base of <parameter>x</parameter>, (2 â?¤ <parameter>base</parameter> â?¤ 36)</para>
       </refsect1>
       <refsect1>
         <title>OpenDocument Format (ODF) Compatibility</title>
@@ -4768,6 +4768,36 @@
       </para>
       </refsect1>
     </refentry>
+    <refentry id="gnumeric-ATL_LAST">
+      <refmeta>
+        <refentrytitle>
+          <function>ATL_LAST</function>
+        </refentrytitle>
+      </refmeta>
+      <refnamediv>
+        <refname>
+          <function>ATL_LAST</function>
+        </refname>
+        <refpurpose>
+        sample real-time data source
+      </refpurpose>
+      </refnamediv>
+      <refsynopsisdiv>
+        <synopsis><function>ATL_LAST</function>(<parameter>tag</parameter>)</synopsis>
+      </refsynopsisdiv>
+      <refsect1>
+        <title>Arguments</title>
+        <para><parameter>tag</parameter>: tag to watch</para>
+      </refsect1>
+      <refsect1>
+        <title>Description</title>
+        <para><function>ATL_LAST</function> is a sample implementation of a real time data source.  It takes a string tag and monitors the named pipe ~/atl for changes to the value of that tag.</para>
+      </refsect1>
+      <refsect1>
+        <title>Note</title>
+        <para>This is not intended to be generally enabled and is OFF by default.</para>
+      </refsect1>
+    </refentry>
     <refentry id="gnumeric-COUPDAYBS">
       <refmeta>
         <refentrytitle>
@@ -8812,7 +8842,7 @@
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para><function>TYPE</function> returns a number indicating the data type of @{ value}:</para>
+        <para><function>TYPE</function> returns a number indicating the data type of <parameter>value</parameter>:</para>
         <para>1  	= number</para>
         <para>2  	= text</para>
         <para>4  	= boolean</para>
@@ -9314,11 +9344,11 @@
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para><function>COLUMN</function> function returns a Nx1 array containing the sequence of integers from the first column to the last column of <parameter>reference</parameter>.</para>
+        <para><function>COLUMN</function> function returns a Nx1 array containing the sequence of integers from the first column to the last column of <parameter>x</parameter>.</para>
       </refsect1>
       <refsect1>
         <title>Note</title>
-        <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
+        <para>If <parameter>x</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
       </refsect1>
       <refsect1>
         <title>See also</title>
@@ -9667,11 +9697,11 @@
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para><function>ROW</function> function returns a 1xN array containing the sequence of integers from the first row to the last row of <parameter>reference</parameter>.</para>
+        <para><function>ROW</function> function returns a 1xN array containing the sequence of integers from the first row to the last row of <parameter>x</parameter>.</para>
       </refsect1>
       <refsect1>
         <title>Note</title>
-        <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
+        <para>If <parameter>x</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
       </refsect1>
       <refsect1>
         <title>See also</title>
@@ -15005,7 +15035,7 @@
           <function>EXPONDIST</function>
         </refname>
         <refpurpose>
-        porbaility density or cumulative distribution function of the exponential distribution
+        probability density or cumulative distribution function of the exponential distribution
       </refpurpose>
       </refnamediv>
       <refsynopsisdiv>
@@ -15297,7 +15327,7 @@
       <refsect1>
         <title>Description</title>
         <para>The results are given as an array.</para>
-        <para>If the <parameter>bin_array</parameter> is empty, this function returns the number of data points in <parameter>data_array</parameter>.</para>
+        <para>If the <parameter>bins_array</parameter> is empty, this function returns the number of data points in <parameter>data_array</parameter>.</para>
       </refsect1>
       <refsect1>
         <title>Microsoft Excel Compatibility</title>
@@ -21084,14 +21114,13 @@
       </refsynopsisdiv>
       <refsect1>
         <title>Arguments</title>
-        <para><parameter>abscissae</parameter>: abscissae of the given data points</para>
+        <para><parameter>abscissae</parameter>: ordered abscissae of the given data points</para>
         <para><parameter>ordinates</parameter>: ordinates of the given data points</para>
         <para><parameter>targets</parameter>: abscissae of the interpolated data</para>
-        <para><parameter>interpolation</parameter>: method of interpolation, defaults to none</para>
+        <para><parameter>interpolation</parameter>: method of interpolation, defaults to 0 ('linear')</para>
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para>If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.</para>
         <para>The output consists always of one column of numbers.</para>
         <para>Possible interpolation methods are:</para>
         <para>0: linear;</para>
@@ -21103,7 +21132,7 @@
       </refsect1>
       <refsect1>
         <title>Note</title>
-        <para>Strings and empty cells in <parameter>abscissae</parameter> and <parameter>ordinates</parameter> are ignored. If several target data are provided they must be in the same column in consecutive cells.</para>
+        <para>The <parameter>abscissae</parameter> must be given in increasing order. If any of interpolation methods 1 ('linear with averaging'), 3 ('staircase with averaging'), and 5 ('natural cubic spline with averaging') is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order. Strings and empty cells in <parameter>abscissae</parameter> and <parameter>ordinates</parameter> are ignored. If several target data are provided they must be in the same column in consecutive cells.</para>
       </refsect1>
       <refsect1>
         <title>See also</title>
diff --git a/plugins/fn-eng/functions.c b/plugins/fn-eng/functions.c
index b21bdef..f37fa3d 100644
--- a/plugins/fn-eng/functions.c
+++ b/plugins/fn-eng/functions.c
@@ -376,7 +376,7 @@ gnumeric_dec2hex (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 static GnmFuncHelp const help_decimal[] = {
         { GNM_FUNC_HELP_NAME, F_("DECIMAL:decimal representation of @{x}") },
         { GNM_FUNC_HELP_ARG, F_("x:number in base @{base}") },
-        { GNM_FUNC_HELP_ARG, F_("base:base of @{x}, (2 \xe2\x89\xa4 @{b} \xe2\x89\xa4 36)") },
+        { GNM_FUNC_HELP_ARG, F_("base:base of @{x}, (2 \xe2\x89\xa4 @{base} \xe2\x89\xa4 36)") },
 	{ GNM_FUNC_HELP_ODF, F_("This function is OpenFormula compatible.") },
         { GNM_FUNC_HELP_EXAMPLES, "=DECIMAL(\"A1\",16)" },
         { GNM_FUNC_HELP_EXAMPLES, "=DECIMAL(\"A1\",15)" },
diff --git a/plugins/fn-info/functions.c b/plugins/fn-info/functions.c
index 7dd1925..5539ba1 100644
--- a/plugins/fn-info/functions.c
+++ b/plugins/fn-info/functions.c
@@ -1750,7 +1750,7 @@ gnumeric_n (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 static GnmFuncHelp const help_type[] = {
         { GNM_FUNC_HELP_NAME, F_("TYPE:a number indicating the data type of @{value}")},
         { GNM_FUNC_HELP_ARG, F_("value:a value")},
-	{ GNM_FUNC_HELP_DESCRIPTION, F_("TYPE returns a number indicating the data type of @{ value}:\n"
+	{ GNM_FUNC_HELP_DESCRIPTION, F_("TYPE returns a number indicating the data type of @{value}:\n"
 					"1  \t= number\n"
 					"2  \t= text\n"
 					"4  \t= boolean\n"
diff --git a/plugins/fn-lookup/functions.c b/plugins/fn-lookup/functions.c
index 7c1125f..276092b 100644
--- a/plugins/fn-lookup/functions.c
+++ b/plugins/fn-lookup/functions.c
@@ -1337,8 +1337,8 @@ static GnmFuncHelp const help_column[] = {
 	{ GNM_FUNC_HELP_ARG, F_("x:reference, defaults to the position of the current expression") },
 	{ GNM_FUNC_HELP_DESCRIPTION, F_("COLUMN function returns a Nx1 array containing the sequence "
 					"of integers "
-					"from the first column to the last column of @{reference}.") },
-	{ GNM_FUNC_HELP_NOTE, F_("If @{reference} is neither an array nor a reference nor a range, "
+					"from the first column to the last column of @{x}.") },
+	{ GNM_FUNC_HELP_NOTE, F_("If @{x} is neither an array nor a reference nor a range, "
 				 "returns #VALUE!") },
 	{ GNM_FUNC_HELP_EXAMPLES, "=COLUMN(A1:C4)" },
 	{ GNM_FUNC_HELP_EXAMPLES, "=COLUMN(A:C)" },
@@ -1489,8 +1489,8 @@ static GnmFuncHelp const help_row[] = {
 	{ GNM_FUNC_HELP_ARG, F_("x:reference, defaults to the position of the current expression") },
 	{ GNM_FUNC_HELP_DESCRIPTION, F_("ROW function returns a 1xN array containing the "
 					"sequence of integers "
-					"from the first row to the last row of @{reference}.") },
-	{ GNM_FUNC_HELP_NOTE, F_("If @{reference} is neither an array nor a reference nor a range, "
+					"from the first row to the last row of @{x}.") },
+	{ GNM_FUNC_HELP_NOTE, F_("If @{x} is neither an array nor a reference nor a range, "
 				 "returns #VALUE!") },
 	{ GNM_FUNC_HELP_EXAMPLES, "=ROW(A1:D3)" },
 	{ GNM_FUNC_HELP_EXAMPLES, "=ROW(1:3)" },
diff --git a/plugins/fn-stat/functions.c b/plugins/fn-stat/functions.c
index 75a8744..f533aa5 100644
--- a/plugins/fn-stat/functions.c
+++ b/plugins/fn-stat/functions.c
@@ -3046,7 +3046,7 @@ static GnmFuncHelp const help_frequency[] = {
 	{ GNM_FUNC_HELP_ARG, F_("data_array:data values")},
 	{ GNM_FUNC_HELP_ARG, F_("bins_array:array of cutoff values")},
 	{ GNM_FUNC_HELP_DESCRIPTION, F_("The results are given as an array.") },
-	{ GNM_FUNC_HELP_DESCRIPTION, F_("If the @{bin_array} is empty, this function "
+	{ GNM_FUNC_HELP_DESCRIPTION, F_("If the @{bins_array} is empty, this function "
 					"returns the number of data points "
 					"in @{data_array}.")},
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]