GNOME.org
 

[gnumeric] fn-date: propagate doc fixes.

commit 67a20b15f1a0e9c5f059336cb369fa0ea29b6247
Author: Morten Welinder <terra gnome org>
Date:   Tue Jul 6 09:32:23 2010 -0400

    fn-date: propagate doc fixes.

 doc/C/func.defs     |   35 ++++++++++++++++++++--------
 doc/C/functions.xml |   62 ++++++++++++++++++++++++++++++++++++++++++++------
 2 files changed, 79 insertions(+), 18 deletions(-)
---
diff --git a/doc/C/func.defs b/doc/C/func.defs
index 5ef77ae..6a1ce49 100644
--- a/doc/C/func.defs
+++ b/doc/C/func.defs
@@ -770,7 +770,7 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
 @SHORTDESC=year corresponding to the ISO week number
 @SYNTAX=ISOYEAR(date)
 @ARGUMENTDESCRIPTION= {date}: date serial value
- DESCRIPTION=ISOYEAR calculates the year to go with week number according to the ISE 8601 standard.
+ DESCRIPTION=ISOYEAR calculates the year to go with week number according to the ISO 8601 standard.
 @NOTE=January 1 of a year is sometimes in week 52 or 53 of the previous year.  Similarly, December 31 is sometimes in week 1 of the following year.
 @SEEALSO=ISOWEEKNUM,YEAR
 
@@ -795,12 +795,14 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
 @CATEGORY=Date/Time
 @FUNCTION=NETWORKDAYS
 @SHORTDESC=number of workdays in range
- SYNTAX=NETWORKDAYS(start_date,end_date,holidays)
+ SYNTAX=NETWORKDAYS(start_date,end_date,holidays,weekend)
 @ARGUMENTDESCRIPTION= {start_date}: starting date serial value
 @{end_date}: ending date serial value
 @{holidays}: array of holidays
+ {weekend}: array indicating whether a weekday (S, M, T, W, T, F, S) is on the weekend, defaults to {TRUE, FALSE, FALSE, FALSE, FALSE, FALSE, TRUE}.
 @DESCRIPTION=NETWORKDAYS calculates the number of days from @{start_date} to @{end_date} skipping weekends and @{holidays} in the process.
- EXCEL=This function is Excel compatible.
+ EXCEL=This function is Excel compatible if the last argument is omitted.
+ ODF=This function is OpenFormula compatible.
 @SEEALSO=WORKDAY
 
 @CATEGORY=Date/Time
@@ -871,7 +873,7 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
 @ARGUMENTDESCRIPTION= {date}: date serial value
 @{method}: numbering system
 @DESCRIPTION=The WEEKDAY function returns the day-of-week of @{date}.  The value of @{method} determines how days are numbered.
- NOTE=If @{method} is 1, then Sunday is 1, Monday is 2, etc. If @{method} is 2, then Monday is 1, Sunday is 2, etc. If @{method} is 3, then Monday is 0, Sunday is 1, etc.
+ NOTE=If @{method} is 1, then Sunday is 1, Monday is 2, etc. If @{method} is 2, then Monday is 1, Tuesday is 2, etc. If @{method} is 3, then Monday is 0, Tuesday is 1, etc.
 @EXCEL=This function is Excel compatible.
 @SEEALSO=DATE,ISOWEEKNUM
 
@@ -888,13 +890,15 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
 @CATEGORY=Date/Time
 @FUNCTION=WORKDAY
 @SHORTDESC=add working days
- SYNTAX=WORKDAY(date,days,holidays)
+ SYNTAX=WORKDAY(date,days,holidays,weekend)
 @ARGUMENTDESCRIPTION= {date}: date serial value
 @{days}: number of days to add
 @{holidays}: array of holidays
+ {weekend}: array indicating whether a weekday (S, M, T, W, T, F, S) is on the weekend, defaults to {TRUE, FALSE, FALSE, FALSE, FALSE, FALSE, TRUE}.
 @DESCRIPTION=WORKDAY adjusts @{date} by @{days} skipping over weekends and @{holidays} in the process.
 @NOTE= {days} may be negative.
- EXCEL=This function is Excel compatible.
+ EXCEL=This function is Excel compatible if the last argument is omitted.
+ ODF=This function is OpenFormula compatible.
 @SEEALSO=NETWORKDAYS
 
 @CATEGORY=Date/Time
@@ -1021,7 +1025,9 @@ Distance:
 	'ft'  			Foot
 	'yd'  		Yard
 	'ang' 		Angstrom
-	'Pica'		Pica
+	'Pica'		Pica Points
+	'picapt'		Pica Points
+	'pica'		Pica
 
 Time:
 	'yr'  			Year
@@ -1096,7 +1102,8 @@ For metric units any of the following prefixes can be used:
 	'z'  	zepto 		1E-21
 	'y'  	yocto 		1E-24
 @NOTE=If @{from} and @{to} are different types, CONVERT returns #N/A!
- EXCEL=This function is Excel compatible.
+ EXCEL=This function is Excel compatible (except "picapt").
+ ODF=This function is OpenFormula compatible.
 
 @CATEGORY=Engineering
 @FUNCTION=DEC2BIN
@@ -1344,6 +1351,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)
@@ -2499,7 +2514,7 @@ Otherwise ACCRINT returns the sum of the interest accrued in all coupon periods
 
 @CATEGORY=Information
 @FUNCTION=ERROR.TYPE
- SHORTDESC=the type of @error
+ SHORTDESC=the type of @{error}
 @SYNTAX=ERROR.TYPE(error)
 @ARGUMENTDESCRIPTION= {error}: an error
 @DESCRIPTION=ERROR.TYPE returns an error number corresponding to the given error value.  The error numbers for error values are:
@@ -6039,7 +6054,7 @@ The distinction between half-width and full-width characters is described in htt
 
 @CATEGORY=String
 @FUNCTION=UPPER
- SHORTDESC=an upper-case version of the string @text
+ SHORTDESC=an upper-case version of the string @{text}
 @SYNTAX=UPPER(text)
 @ARGUMENTDESCRIPTION= {text}: string
 @EXCEL=This function is Excel compatible.
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index c23493e..d74df94 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -2820,7 +2820,7 @@
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para><function>ISOYEAR</function> calculates the year to go with week number according to the ISE 8601 standard.</para>
+        <para><function>ISOYEAR</function> calculates the year to go with week number according to the ISO 8601 standard.</para>
       </refsect1>
       <refsect1>
         <title>Note</title>
@@ -2922,13 +2922,14 @@
       </refpurpose>
       </refnamediv>
       <refsynopsisdiv>
-        <synopsis><function>NETWORKDAYS</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>holidays</parameter>)</synopsis>
+        <synopsis><function>NETWORKDAYS</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>holidays</parameter>,<parameter>weekend</parameter>)</synopsis>
       </refsynopsisdiv>
       <refsect1>
         <title>Arguments</title>
         <para><parameter>start_date</parameter>: starting date serial value</para>
         <para><parameter>end_date</parameter>: ending date serial value</para>
         <para><parameter>holidays</parameter>: array of holidays</para>
+        <para><parameter>weekend</parameter>: array indicating whether a weekday (S, M, T, W, T, F, S) is on the weekend, defaults to {TRUE, FALSE, FALSE, FALSE, FALSE, FALSE, TRUE}.</para>
       </refsect1>
       <refsect1>
         <title>Description</title>
@@ -2936,7 +2937,11 @@
       </refsect1>
       <refsect1>
         <title>Microsoft Excel Compatibility</title>
-        <para>This function is Excel compatible.</para>
+        <para>This function is Excel compatible if the last argument is omitted.</para>
+      </refsect1>
+      <refsect1>
+        <title>OpenDocument Format (ODF) Compatibility</title>
+        <para>This function is OpenFormula compatible.</para>
       </refsect1>
       <refsect1>
         <title>See also</title>
@@ -3209,7 +3214,7 @@
       </refsect1>
       <refsect1>
         <title>Note</title>
-        <para>If <parameter>method</parameter> is 1, then Sunday is 1, Monday is 2, etc. If <parameter>method</parameter> is 2, then Monday is 1, Sunday is 2, etc. If <parameter>method</parameter> is 3, then Monday is 0, Sunday is 1, etc.</para>
+        <para>If <parameter>method</parameter> is 1, then Sunday is 1, Monday is 2, etc. If <parameter>method</parameter> is 2, then Monday is 1, Tuesday is 2, etc. If <parameter>method</parameter> is 3, then Monday is 0, Tuesday is 1, etc.</para>
       </refsect1>
       <refsect1>
         <title>Microsoft Excel Compatibility</title>
@@ -3273,13 +3278,14 @@
       </refpurpose>
       </refnamediv>
       <refsynopsisdiv>
-        <synopsis><function>WORKDAY</function>(<parameter>date</parameter>,<parameter>days</parameter>,<parameter>holidays</parameter>)</synopsis>
+        <synopsis><function>WORKDAY</function>(<parameter>date</parameter>,<parameter>days</parameter>,<parameter>holidays</parameter>,<parameter>weekend</parameter>)</synopsis>
       </refsynopsisdiv>
       <refsect1>
         <title>Arguments</title>
         <para><parameter>date</parameter>: date serial value</para>
         <para><parameter>days</parameter>: number of days to add</para>
         <para><parameter>holidays</parameter>: array of holidays</para>
+        <para><parameter>weekend</parameter>: array indicating whether a weekday (S, M, T, W, T, F, S) is on the weekend, defaults to {TRUE, FALSE, FALSE, FALSE, FALSE, FALSE, TRUE}.</para>
       </refsect1>
       <refsect1>
         <title>Description</title>
@@ -3291,7 +3297,11 @@
       </refsect1>
       <refsect1>
         <title>Microsoft Excel Compatibility</title>
-        <para>This function is Excel compatible.</para>
+        <para>This function is Excel compatible if the last argument is omitted.</para>
+      </refsect1>
+      <refsect1>
+        <title>OpenDocument Format (ODF) Compatibility</title>
+        <para>This function is OpenFormula compatible.</para>
       </refsect1>
       <refsect1>
         <title>See also</title>
@@ -3717,7 +3727,9 @@
         <para>	'ft'  			Foot</para>
         <para>	'yd'  		Yard</para>
         <para>	'ang' 		Angstrom</para>
-        <para>	'Pica'		Pica</para>
+        <para>	'Pica'		Pica Points</para>
+        <para>	'picapt'		Pica Points</para>
+        <para>	'pica'		Pica</para>
         <para/>
         <para>Time:</para>
         <para>	'yr'  			Year</para>
@@ -3798,7 +3810,11 @@
       </refsect1>
       <refsect1>
         <title>Microsoft Excel Compatibility</title>
-        <para>This function is Excel compatible.</para>
+        <para>This function is Excel compatible (except "picapt").</para>
+      </refsect1>
+      <refsect1>
+        <title>OpenDocument Format (ODF) Compatibility</title>
+        <para>This function is OpenFormula compatible.</para>
       </refsect1>
     </refentry>
     <refentry id="gnumeric-DEC2BIN">
@@ -4665,6 +4681,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>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]