GNOME.org
 

[gnumeric] fix some function descriptions

commit c3d24a4e701ac78e1c3705771b3da63ba63a70a0
Author: Andreas J. Guelzow <aguelzow pyrshep ca>
Date:   Fri Aug 14 12:38:46 2009 -0600

    fix some function descriptions
    
    2009-08-14 Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_len*): make desription consitent
    	(help_mid): ditto
    	(help_leftb): add argument description
    	(help_midb): ditto
    	(help_right*): ditto
    
    2009-07-14  Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (functions.c): remove remains of description
    	  conversion
    
    2009-08-14  Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* derivatives.c (help_opt_2_asset_correlation): add argument and
    	  fix argument order
    
    2009-08-14  Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_hex2dec): remove incorrect argument
    
    2009-08-14  Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_*): change x:value to x:number throughout
    	(help_asin): add argument description

 plugins/derivatives/ChangeLog |    5 +++++
 plugins/derivatives/options.c |    3 ++-
 plugins/fn-eng/ChangeLog      |    4 ++++
 plugins/fn-eng/functions.c    |    3 ---
 plugins/fn-math/ChangeLog     |    5 +++++
 plugins/fn-math/functions.c   |    9 +++++----
 plugins/fn-random/ChangeLog   |    5 +++++
 plugins/fn-random/functions.c |    3 ---
 plugins/fn-string/ChangeLog   |    8 ++++++++
 plugins/fn-string/functions.c |   33 +++++++++++++++++++--------------
 10 files changed, 53 insertions(+), 25 deletions(-)
---
diff --git a/plugins/derivatives/ChangeLog b/plugins/derivatives/ChangeLog
index 7ac1f63..f5dbf63 100644
--- a/plugins/derivatives/ChangeLog
+++ b/plugins/derivatives/ChangeLog
@@ -1,3 +1,8 @@
+2009-08-14  Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* derivatives.c (help_opt_2_asset_correlation): add argument and
+	  fix argument order
+
 2009-08-06  Andreas J. Guelzow <aguelzow pyrshep ca>
 
 	Fixes [#448580]
diff --git a/plugins/derivatives/options.c b/plugins/derivatives/options.c
index 016d00e..249fc95 100644
--- a/plugins/derivatives/options.c
+++ b/plugins/derivatives/options.c
@@ -1618,13 +1618,14 @@ static GnmFuncHelp const help_opt_2_asset_correlation[] = {
         { GNM_FUNC_HELP_ARG, F_("strike1:strike prices of the first option")},
         { GNM_FUNC_HELP_ARG, F_("strike1:strike prices of the second option")},
 	DEF_ARG_TIME_MATURITY_Y,
-	DEF_ARG_RATE_RISKFREE_ANN,
         { GNM_FUNC_HELP_ARG, F_("cost_of_carry1:net cost of holding the underlying asset of the first option "
 				"(for common stocks, the risk free rate less the dividend yield)")},
         { GNM_FUNC_HELP_ARG, F_("cost_of_carry2:net cost of holding the underlying asset of the second option "
 				"(for common stocks, the risk free rate less the dividend yield)")},
+	DEF_ARG_RATE_RISKFREE_ANN,
         { GNM_FUNC_HELP_ARG, F_("volatility1:annualized volatility in price of the underlying asset of the first option")},
         { GNM_FUNC_HELP_ARG, F_("volatility2:annualized volatility in price of the underlying asset of the second option")},
+	{ GNM_FUNC_HELP_ARG, F_("rho:correlation between the two underlying assets")},
 	{ GNM_FUNC_HELP_DESCRIPTION, F_("OPT_2_ASSET_CORRELATION models the theoretical price of options "
 					"on 2 assets with correlation @{rho}. The payoff for a call is "
 					"max(@{spot2} - @{strike2},0) if @{spot1} > @{strike1} or 0 otherwise. "
diff --git a/plugins/fn-eng/ChangeLog b/plugins/fn-eng/ChangeLog
index ef93aa2..fe5a202 100644
--- a/plugins/fn-eng/ChangeLog
+++ b/plugins/fn-eng/ChangeLog
@@ -1,3 +1,7 @@
+2009-08-14  Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* functions.c (help_hex2dec): remove incorrect argument
+
 2009-08-05  Andreas J. Guelzow <aguelzow pyrshep ca>
 
 	* functions.c (help_besselj): fix spelling
diff --git a/plugins/fn-eng/functions.c b/plugins/fn-eng/functions.c
index f0f2619..7199fdd 100644
--- a/plugins/fn-eng/functions.c
+++ b/plugins/fn-eng/functions.c
@@ -518,9 +518,6 @@ gnumeric_hex2oct (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 static GnmFuncHelp const help_hex2dec[] = {
         { GNM_FUNC_HELP_NAME, F_("HEX2DEC:decimal representation of the hexadecimal number @{x}") },
         { GNM_FUNC_HELP_ARG, F_("x:a hexadecimal number, either as a string or as a number if no A to F are needed") },
-        { GNM_FUNC_HELP_ARG, F_("places:number of digits") },
-        { GNM_FUNC_HELP_DESCRIPTION, F_("If @{places} is given, HEX2DEC pads the result with zeros to achieve "
-					"exactly @{places} digits. If this is not possible, HEX2DEC returns #NUM!") },
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
         { GNM_FUNC_HELP_EXAMPLES, "=HEX2DEC(\"2A\")" },
         { GNM_FUNC_HELP_SEEALSO, ("DEC2HEX,HEX2BIN,HEX2OCT") },
diff --git a/plugins/fn-math/ChangeLog b/plugins/fn-math/ChangeLog
index e5f95f8..2e70a14 100644
--- a/plugins/fn-math/ChangeLog
+++ b/plugins/fn-math/ChangeLog
@@ -1,3 +1,8 @@
+2009-08-14  Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* functions.c (help_*): change x:value to x:number throughout
+	(help_asin): add argument description
+
 2009-06-30  Andreas J. Guelzow <aguelzow pyrshep ca>
 
 	* functions.c (help_sin): fix order of items
diff --git a/plugins/fn-math/functions.c b/plugins/fn-math/functions.c
index 720711e..1c69f2a 100644
--- a/plugins/fn-math/functions.c
+++ b/plugins/fn-math/functions.c
@@ -301,7 +301,7 @@ gnumeric_acot (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 
 static GnmFuncHelp const help_acoth[] = {
 	{ GNM_FUNC_HELP_NAME, F_("ACOTH:inverse hyperbolic cotangent of a value")},
-	{ GNM_FUNC_HELP_ARG, F_("x:value")},
+	{ GNM_FUNC_HELP_ARG, F_("x:number")},
 	{ GNM_FUNC_HELP_EXAMPLES, "=ACOTH(2.2)" },
 	{ GNM_FUNC_HELP_SEEALSO, "COTH,TANH" },
 	{ GNM_FUNC_HELP_EXTREF, F_("wolfram:InverseHyperbolicCotangent.html") },
@@ -319,6 +319,7 @@ gnumeric_acoth (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 
 static GnmFuncHelp const help_asin[] = {
         { GNM_FUNC_HELP_NAME, F_("ASIN:the arc sine of @{x}")},
+	{ GNM_FUNC_HELP_ARG, F_("x:number")},
         { GNM_FUNC_HELP_DESCRIPTION, F_("ASIN calculates the arc sine of @{x}; that is the value whose sine is @{x}.")},
  	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
 	{ GNM_FUNC_HELP_NOTE, F_("If @{x} falls outside the range -1 to 1, ASIN returns #NUM!") },	
@@ -707,7 +708,7 @@ gnumeric_cosh (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 
 static GnmFuncHelp const help_cot[] = {
 	{ GNM_FUNC_HELP_NAME, F_("COT:cotangent of a value")},
-	{ GNM_FUNC_HELP_ARG, F_("x:value")},
+	{ GNM_FUNC_HELP_ARG, F_("x:number")},
 	{ GNM_FUNC_HELP_EXAMPLES, "=COT(0.12)" },
 	{ GNM_FUNC_HELP_SEEALSO, "TAN,ACOT" },
 	{ GNM_FUNC_HELP_EXTREF, F_("wolfram:Cotangent.html") },
@@ -725,7 +726,7 @@ gnumeric_cot (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 
 static GnmFuncHelp const help_coth[] = {
 	{ GNM_FUNC_HELP_NAME, F_("COT:hyperbolic cotangent of a value")},
-	{ GNM_FUNC_HELP_ARG, F_("x:value")},
+	{ GNM_FUNC_HELP_ARG, F_("x:number")},
 	{ GNM_FUNC_HELP_EXAMPLES, "=COTH(0.12)" },
 	{ GNM_FUNC_HELP_SEEALSO, "TANH,ACOTH" },
 	{ GNM_FUNC_HELP_EXTREF, F_("wolfram:HyperbolicCotangent.html") },
@@ -904,7 +905,7 @@ gnumeric_combin (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 
 static GnmFuncHelp const help_floor[] = {
 	{ GNM_FUNC_HELP_NAME, F_("FLOOR:nearest multiple of @{significance} whose absolute value is at most ABS(@{x}).") },
-	{ GNM_FUNC_HELP_ARG, F_("x:value.") },
+	{ GNM_FUNC_HELP_ARG, F_("x:number.") },
 	{ GNM_FUNC_HELP_ARG, F_("significance:base multiple (defaults to 1 for @{x} > 0 and -1 for @{x} <0)") },
 	{ GNM_FUNC_HELP_DESCRIPTION, F_(
 			"FLOOR(@{x},@{significance}) is the nearest multiple of @{significance} whose absolute value is at most ABS(@{x})") },
diff --git a/plugins/fn-random/ChangeLog b/plugins/fn-random/ChangeLog
index 48996a3..6fbc019 100644
--- a/plugins/fn-random/ChangeLog
+++ b/plugins/fn-random/ChangeLog
@@ -1,3 +1,8 @@
+2009-07-14  Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* functions.c (functions.c): remove remains of description
+	  conversion
+	
 2009-07-03  Andreas J. Guelzow <aguelzow pyrshep ca>
 
 	* functions.c: conversion to new function description
diff --git a/plugins/fn-random/functions.c b/plugins/fn-random/functions.c
index 9241d1f..eb5ad48 100644
--- a/plugins/fn-random/functions.c
+++ b/plugins/fn-random/functions.c
@@ -276,9 +276,6 @@ static GnmFuncHelp const help_randnegbinom[] = {
         { GNM_FUNC_HELP_ARG, F_("n:number of failures") },
 	{ GNM_FUNC_HELP_NOTE, F_("If @{p} < 0 or @{p} > 1 RANDNEGBINOM returns #NUM!") },
 	{ GNM_FUNC_HELP_NOTE, F_("If @{n} < 1 RANDNEGBINOM returns #NUM!") },
-        { GNM_FUNC_HELP_ARG, F_("area0:first cell area") },
-        { GNM_FUNC_HELP_ARG, F_("area1:second cell area") },
-        { GNM_FUNC_HELP_DESCRIPTION, F_("number.") },
         { GNM_FUNC_HELP_EXAMPLES, "=RANDNEGBINOM(0.5,5)" },
         { GNM_FUNC_HELP_SEEALSO, "RAND,RANDBETWEEN" },
         { GNM_FUNC_HELP_END}
diff --git a/plugins/fn-string/ChangeLog b/plugins/fn-string/ChangeLog
index e0a700b..1051674 100644
--- a/plugins/fn-string/ChangeLog
+++ b/plugins/fn-string/ChangeLog
@@ -1,3 +1,11 @@
+2009-08-14 Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* functions.c (help_len*): make desription consitent
+	(help_mid): ditto
+	(help_leftb): add argument description
+	(help_midb): ditto
+	(help_right*): ditto
+
 2009-07-03 Andreas J. Guelzow <aguelzow pyrshep ca>
 
 	* functions.c (help_*): use language independent strings
diff --git a/plugins/fn-string/functions.c b/plugins/fn-string/functions.c
index d7ae24e..9cd2af2 100644
--- a/plugins/fn-string/functions.c
+++ b/plugins/fn-string/functions.c
@@ -213,8 +213,8 @@ gnumeric_exact (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_len[] = {
-        { GNM_FUNC_HELP_NAME, F_("LEN:the number of characters of the string @{s}.")},
-        { GNM_FUNC_HELP_ARG, F_("s:string")},
+        { GNM_FUNC_HELP_NAME, F_("LEN:the number of characters of the string @{s}")},
+        { GNM_FUNC_HELP_ARG, F_("s:the string")},
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
         { GNM_FUNC_HELP_EXAMPLES, "=LEN(\"Helsinki\")" },
 	{ GNM_FUNC_HELP_EXAMPLES, "=LEN(\"L\xc3\xa9vy\")" },
@@ -230,8 +230,8 @@ gnumeric_len (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 
 /***************************************************************************/
 static GnmFuncHelp const help_lenb[] = {
-        { GNM_FUNC_HELP_NAME, F_("LENB:the number of bytes in the string @{s}.")},
-        { GNM_FUNC_HELP_ARG, F_("s:string")},
+        { GNM_FUNC_HELP_NAME, F_("LENB:the number of bytes in the string @{s}")},
+        { GNM_FUNC_HELP_ARG, F_("s:the string")},
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
         { GNM_FUNC_HELP_EXAMPLES, "=LENB(\"Helsinki\")" },
         { GNM_FUNC_HELP_EXAMPLES, "=LENB(\"L\xc3\xa9vy\")" },
@@ -248,9 +248,10 @@ gnumeric_lenb (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_left[] = {
-	{ GNM_FUNC_HELP_NAME, F_("LEFT:the first @{num_chars} characters.")},
+	{ GNM_FUNC_HELP_NAME, F_("LEFT:the first @{num_chars} characters of the string @{s}")},
+	{ GNM_FUNC_HELP_ARG, F_("s:the string")},   
 	{ GNM_FUNC_HELP_ARG, F_("num_chars:the number of characters to return (defaults to 1)")},   
-	{ GNM_FUNC_HELP_NOTE, F_("If the string is in a right-to-left script, the returned first characters are from the right of the string.")},
+	{ GNM_FUNC_HELP_NOTE, F_("If the string @{s} is in a right-to-left script, the returned first characters are from the right of the string.")},
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.")},
 	{ GNM_FUNC_HELP_ODF, F_("This function is OpenFormula compatible.")},
 	{ GNM_FUNC_HELP_EXAMPLES, "=LEFT(\"L\xc3\xa9vy\",3)" },
@@ -279,7 +280,8 @@ gnumeric_left (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_leftb[] = {
-	{ GNM_FUNC_HELP_NAME, F_("LEFTB:the first characters comprising at most @{num_bytes} bytes.")},
+	{ GNM_FUNC_HELP_NAME, F_("LEFTB:the first characters  of the string @{s} comprising at most @{num_bytes} bytes")},
+	{ GNM_FUNC_HELP_ARG, F_("s:the string")},   
 	{ GNM_FUNC_HELP_ARG, F_("num_bytes:the maximum number of bytes to return (defaults to 1)")},   
 	{ GNM_FUNC_HELP_NOTE, F_("The semantics of this function is subject to change as various applications implement it.")},
 	{ GNM_FUNC_HELP_NOTE, F_("If the string is in a right-to-left script, the returned first characters are from the right of the string.")},
@@ -330,8 +332,8 @@ gnumeric_lower (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_mid[] = {
-	{ GNM_FUNC_HELP_NAME, F_("MID:the substring starting at position @{position} consisting of @{length} characters")},
-	{ GNM_FUNC_HELP_ARG, F_("string:string")},   
+	{ GNM_FUNC_HELP_NAME, F_("MID:the substring of the string @{s} starting at position @{position} consisting of @{length} characters")},
+	{ GNM_FUNC_HELP_ARG, F_("s:the string")},   
 	{ GNM_FUNC_HELP_ARG, F_("position:the starting position")},   
 	{ GNM_FUNC_HELP_ARG, F_("length:the number of characters to return")},   
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.")},
@@ -370,7 +372,8 @@ gnumeric_mid (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_midb[] = {
-	{ GNM_FUNC_HELP_NAME, F_("MIDB:the characters following  the first @{start_pos} bytes comprising at most @{num_bytes} bytes.")},
+	{ GNM_FUNC_HELP_NAME, F_("MIDB:the characters following the first @{start_pos} bytes comprising at most @{num_bytes} bytes")},
+	{ GNM_FUNC_HELP_ARG, F_("s:the string")},   
 	{ GNM_FUNC_HELP_ARG, F_("start_pos:the number of the byte with which to start (defaults to 1)")},   
 	{ GNM_FUNC_HELP_ARG, F_("num_bytes:the maximum number of bytes to return (defaults to 1)")},   
 	{ GNM_FUNC_HELP_NOTE, F_("The semantics of this function is subject to change as various applications implement it.")},
@@ -413,9 +416,10 @@ gnumeric_midb (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_right[] = {
-	{ GNM_FUNC_HELP_NAME, F_("RIGHT:the last @{num_chars} characters")},
+	{ GNM_FUNC_HELP_NAME, F_("RIGHT:the last @{num_chars} characters of the string @{s}")},
+	{ GNM_FUNC_HELP_ARG, F_("s:the string")},   
 	{ GNM_FUNC_HELP_ARG, F_("num_chars:the number of characters to return (defaults to 1)")},   
-	{ GNM_FUNC_HELP_NOTE, F_("If the string is in a right-to-left script, the returned last characters are from the left of the string.")},
+	{ GNM_FUNC_HELP_NOTE, F_("If the string @{s} is in a right-to-left script, the returned last characters are from the left of the string.")},
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.")},
 	{ GNM_FUNC_HELP_ODF, F_("This function is OpenFormula compatible.")},
 	{ GNM_FUNC_HELP_EXAMPLES, "=RIGHT(\"L\xc3\xa9vy\",2)" },
@@ -448,10 +452,11 @@ gnumeric_right (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_rightb[] = {
-	{ GNM_FUNC_HELP_NAME, F_("RIGHTB:the last characters comprising at most @{num_bytes} bytes.")},
+	{ GNM_FUNC_HELP_NAME, F_("RIGHTB:the last characters of the string @{s} comprising at most @{num_bytes} bytes")},
+	{ GNM_FUNC_HELP_ARG, F_("s:the string")},   
 	{ GNM_FUNC_HELP_ARG, F_("num_bytes:the maximum number of bytes to return (defaults to 1)")},   
 	{ GNM_FUNC_HELP_NOTE, F_("The semantics of this function is subject to change as various applications implement it.")},
-	{ GNM_FUNC_HELP_NOTE, F_("If the string is in a right-to-left script, the returned last characters are from the left of the string.")},
+	{ GNM_FUNC_HELP_NOTE, F_("If the string @{s} is in a right-to-left script, the returned last characters are from the left of the string.")},
 	{ GNM_FUNC_HELP_EXCEL, F_("While this function is syntactically Excel compatible, the differences in the underlying text encoding will usually yield different results.")},
 	{ GNM_FUNC_HELP_ODF, F_("While this function is OpenFormula compatible, most of its behavior is, at this time, implementation specific.")},
 	{ GNM_FUNC_HELP_EXAMPLES, "=RIGHTB(\"L\xc3\xa9vy\",2)" },
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]