GNOME.org
 

[gnumeric] Fix various function docs issues. [#625102]

commit d772d3d4a0e687e8e5259c1c08fe69e4c302224f
Author: Andreas J Guelzow <aguelzow pyrshep ca>
Date:   Fri Jul 23 11:26:00 2010 -0600

    Fix various function docs issues.  [#625102]
    
    2010-07-23 Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_searchb): fix description
    
    2010-07-23 Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_trunc): fix argument description
    
    2010-07-23  Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_sheet): fix description
    
    2010-07-01 Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_error): fix description
    
    2010-07-23  Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* functions.c (help_vdb): fix description
    
    2010-07-23  Andreas J. Guelzow <aguelzow pyrshep ca>
    
    	* options.c (help_opt_bs_gamma): fix description
    	(help_opt_bs_vega): ditto
    	(help_opt_bs_rho): ditto

 NEWS                             |    2 +-
 plugins/fn-derivatives/ChangeLog |    6 ++++++
 plugins/fn-derivatives/options.c |    6 +++---
 plugins/fn-financial/ChangeLog   |    4 ++++
 plugins/fn-financial/functions.c |    2 +-
 plugins/fn-info/ChangeLog        |    4 ++++
 plugins/fn-info/functions.c      |    2 +-
 plugins/fn-lookup/ChangeLog      |   14 +++++++++-----
 plugins/fn-lookup/functions.c    |    5 +++--
 plugins/fn-math/ChangeLog        |    4 ++++
 plugins/fn-math/functions.c      |    2 +-
 plugins/fn-string/ChangeLog      |    4 ++++
 plugins/fn-string/functions.c    |    4 ++--
 13 files changed, 43 insertions(+), 16 deletions(-)
---
diff --git a/NEWS b/NEWS
index 692ab0a..caafec7 100644
--- a/NEWS
+++ b/NEWS
@@ -13,7 +13,7 @@ Andreas:
 	* Fix undo of object creation followed by duplication. [#623566]
 	* Avoid creating interacting auto filters. [#607086]
 	* Improve items of the cell context menu. [#74359]
-	* Fix various function docs issues.  [#623669][#624559]
+	* Fix various function docs issues.  [#623669][#624559][#625102]
 	* Improve the presentation of the examples in the function
 	  documentation. [#623455]
 	* Fix HDATE and friends. [#623764]
diff --git a/plugins/fn-derivatives/ChangeLog b/plugins/fn-derivatives/ChangeLog
index da58cd0..d40765f 100644
--- a/plugins/fn-derivatives/ChangeLog
+++ b/plugins/fn-derivatives/ChangeLog
@@ -1,3 +1,9 @@
+2010-07-23  Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* options.c (help_opt_bs_gamma): fix description
+	(help_opt_bs_vega): ditto
+	(help_opt_bs_rho): ditto
+
 2010-06-28  Morten Welinder <terra gnome org>
 
 	* Release 1.10.7
diff --git a/plugins/fn-derivatives/options.c b/plugins/fn-derivatives/options.c
index 34d255e..61e82c8 100644
--- a/plugins/fn-derivatives/options.c
+++ b/plugins/fn-derivatives/options.c
@@ -348,7 +348,7 @@ static GnmFuncHelp const help_opt_bs_gamma[] = {
 	DEF_ARG_RATE_RISKFREE,
 	DEF_ARG_VOLATILITY,
 	DEF_ARG_CC_OPT,
-	{ GNM_FUNC_HELP_DESCRIPTION, F_("OPT_BS_DELTA uses the Black-Scholes model to calculate "
+	{ GNM_FUNC_HELP_DESCRIPTION, F_("OPT_BS_GAMMA uses the Black-Scholes model to calculate "
 					"the 'gamma' of a European option struck at @{strike} "
 					"on an asset with spot price @{spot}. The gamma of an "
 					"option is the second derivative of its price "
@@ -449,7 +449,7 @@ static GnmFuncHelp const help_opt_bs_vega[] = {
 	DEF_ARG_RATE_RISKFREE,
 	DEF_ARG_VOLATILITY,
 	DEF_ARG_CC_OPT,
-	{ GNM_FUNC_HELP_DESCRIPTION, F_("OPT_BS_DELTA uses the Black-Scholes model to calculate "
+	{ GNM_FUNC_HELP_DESCRIPTION, F_("OPT_BS_VEGA uses the Black-Scholes model to calculate "
 					"the 'vega' of a European option struck at @{strike} "
 					"on an asset with spot price @{spot}. The vega of an "
 					"option is the rate of change of its price with "
@@ -515,7 +515,7 @@ static GnmFuncHelp const help_opt_bs_rho[] = {
 	DEF_ARG_RATE_RISKFREE,
 	DEF_ARG_VOLATILITY,
 	DEF_ARG_CC_OPT,
-	{ GNM_FUNC_HELP_DESCRIPTION, F_("OPT_BS_DELTA uses the Black-Scholes model to calculate "
+	{ GNM_FUNC_HELP_DESCRIPTION, F_("OPT_BS_RHO uses the Black-Scholes model to calculate "
 					"the 'rho' of a European option struck at @{strike} "
 					"on an asset with spot price @{spot}. The rho of an "
 					"option is the rate of change of its price with "
diff --git a/plugins/fn-financial/ChangeLog b/plugins/fn-financial/ChangeLog
index cb9ca3b..edb1f21 100644
--- a/plugins/fn-financial/ChangeLog
+++ b/plugins/fn-financial/ChangeLog
@@ -1,3 +1,7 @@
+2010-07-23  Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* functions.c (help_vdb): fix description
+
 2010-06-28  Morten Welinder <terra gnome org>
 
 	* Release 1.10.7
diff --git a/plugins/fn-financial/functions.c b/plugins/fn-financial/functions.c
index c86cf31..7077610 100644
--- a/plugins/fn-financial/functions.c
+++ b/plugins/fn-financial/functions.c
@@ -3271,7 +3271,7 @@ static GnmFuncHelp const help_vdb[] = {
         { GNM_FUNC_HELP_ARG, F_("end_period:last period to accumulate for")},
         { GNM_FUNC_HELP_ARG, F_("factor:factor at which the balance declines")},
         { GNM_FUNC_HELP_ARG, F_("no_switch:do not switch to straight-line depreciation")},
-	{ GNM_FUNC_HELP_DESCRIPTION, F_("VDB calculates the depreciation of an asset for a given period range using the double-declining balance method.") },
+	{ GNM_FUNC_HELP_DESCRIPTION, F_("VDB calculates the depreciation of an asset for a given period range using the variable-rate declining balance method.") },
 	{ GNM_FUNC_HELP_NOTE, F_("If @{no_switch} is FALSE, the calculation switches to straight-line depreciation when depreciation is greater than the declining balance calculation.") },
         { GNM_FUNC_HELP_SEEALSO, "DB,DDB"},
 	{ GNM_FUNC_HELP_END }
diff --git a/plugins/fn-info/ChangeLog b/plugins/fn-info/ChangeLog
index fba880c..1d86a34 100644
--- a/plugins/fn-info/ChangeLog
+++ b/plugins/fn-info/ChangeLog
@@ -1,5 +1,9 @@
 2010-07-01 Andreas J. Guelzow <aguelzow pyrshep ca>
 
+	* functions.c (help_error): fix description
+
+2010-07-01 Andreas J. Guelzow <aguelzow pyrshep ca>
+
 	* functions.c (help_error_type): fix argument mark-up
 
 2010-06-28  Morten Welinder <terra gnome org>
diff --git a/plugins/fn-info/functions.c b/plugins/fn-info/functions.c
index c6414f9..7dd1925 100644
--- a/plugins/fn-info/functions.c
+++ b/plugins/fn-info/functions.c
@@ -1548,7 +1548,7 @@ gnumeric_na (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 /***************************************************************************/
 
 static GnmFuncHelp const help_error[] = {
-        { GNM_FUNC_HELP_NAME, F_("ERROR:the error with name @{text}")},
+        { GNM_FUNC_HELP_NAME, F_("ERROR:the error with the given @{name}")},
         { GNM_FUNC_HELP_ARG, F_("name:string")},
         { GNM_FUNC_HELP_EXAMPLES, "=ERROR(\"#N/A\")" },
         { GNM_FUNC_HELP_EXAMPLES, "=ISNA(ERROR(\"#N/A\"))" },
diff --git a/plugins/fn-lookup/ChangeLog b/plugins/fn-lookup/ChangeLog
index c708440..e4fe6e5 100644
--- a/plugins/fn-lookup/ChangeLog
+++ b/plugins/fn-lookup/ChangeLog
@@ -1,20 +1,24 @@
+2010-07-23  Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* plugins/fn-lookup/functions.c (help_sheet): fix description
+
 2010-07-12  Andreas J. Guelzow <aguelzow pyrshep ca>
 
-	* plugins/fn-lookup/functions.c (callback_function_array):
+	* functions.c (callback_function_array):
 	  make sure we have values, since some functions such as COUNT
 	  can't handle a matrix with NULL values.
 
 2010-07-11  Andreas J. Guelzow <aguelzow pyrshep ca>
 
-	* plugins/fn-lookup/plugin.xml.in: new function SORT
-	* plugins/fn-lookup/functions.c (help_sort): new
+	* plugin.xml.in: new function SORT
+	* functions.c (help_sort): new
 	(gnumeric_sort): new
 	(lookup_functions): add new function SORT
 
 2010-07-11  Andreas J. Guelzow <aguelzow pyrshep ca>
 
-	* plugins/fn-lookup/plugin.xml.in: new function ARRAY
-	* plugins/fn-lookup/functions.c (help_array): new
+	* plugin.xml.in: new function ARRAY
+	* functions.c (help_array): new
 	(gnumeric_array): new
 	(callback_function_array): new
 	(lookup_functions): add new function ARRAY
diff --git a/plugins/fn-lookup/functions.c b/plugins/fn-lookup/functions.c
index a2f2e9d..7c1125f 100644
--- a/plugins/fn-lookup/functions.c
+++ b/plugins/fn-lookup/functions.c
@@ -1591,8 +1591,9 @@ gnumeric_sheets (GnmFuncEvalInfo *ei, GnmValue const * const *args)
 static GnmFuncHelp const help_sheet[] = {
 	{ GNM_FUNC_HELP_NAME, F_("SHEET:sheet number of @{reference}")},
         { GNM_FUNC_HELP_ARG, F_("reference:reference or literal sheet name, defaults to the current sheet")},
-	{ GNM_FUNC_HELP_NOTE, F_("If @{reference} is neither a reference nor a literal sheet name, "
-				 "SHEETS returns #VALUE!")},
+	{ GNM_FUNC_HELP_NOTE, F_("If @{reference} is neither a reference "
+				 "nor a literal sheet name, "
+				 "SHEET returns #VALUE!")},
         { GNM_FUNC_HELP_EXAMPLES, "=SHEET()" },
         { GNM_FUNC_HELP_EXAMPLES, "=SHEET(\"Sheet1\")" },
         { GNM_FUNC_HELP_SEEALSO, "SHEETS,ROW,COLUMNNUMBER"},
diff --git a/plugins/fn-math/ChangeLog b/plugins/fn-math/ChangeLog
index 5b7424a..8b4dc13 100644
--- a/plugins/fn-math/ChangeLog
+++ b/plugins/fn-math/ChangeLog
@@ -1,3 +1,7 @@
+2010-07-23 Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* functions.c (help_trunc): fix argument description
+
 2010-06-28  Morten Welinder <terra gnome org>
 
 	* Release 1.10.7
diff --git a/plugins/fn-math/functions.c b/plugins/fn-math/functions.c
index 8058115..a1005ca 100644
--- a/plugins/fn-math/functions.c
+++ b/plugins/fn-math/functions.c
@@ -1615,7 +1615,7 @@ gnumeric_pi (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
 static GnmFuncHelp const help_trunc[] = {
         { GNM_FUNC_HELP_NAME, F_("TRUNC:@{x} truncated to @{d} digits")},
         { GNM_FUNC_HELP_ARG, F_("x:number")},
-        { GNM_FUNC_HELP_ARG, F_("x:non-negative integer, defaults to 0")},
+        { GNM_FUNC_HELP_ARG, F_("d:non-negative integer, defaults to 0")},
 	{ GNM_FUNC_HELP_NOTE, F_("If @{d} is omitted or negative then it defaults to zero. If it is not an integer then it is truncated to an integer.")},
 	{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
 	{ GNM_FUNC_HELP_EXAMPLES, "=TRUNC(35.12)"},
diff --git a/plugins/fn-string/ChangeLog b/plugins/fn-string/ChangeLog
index d957879..3c9db11 100644
--- a/plugins/fn-string/ChangeLog
+++ b/plugins/fn-string/ChangeLog
@@ -1,3 +1,7 @@
+2010-07-23 Andreas J. Guelzow <aguelzow pyrshep ca>
+
+	* functions.c (help_searchb): fix description
+	
 2010-07-16 Andreas J. Guelzow <aguelzow pyrshep ca>
 
 	* functions.c (help_char): fix description
diff --git a/plugins/fn-string/functions.c b/plugins/fn-string/functions.c
index 796c5dd..6be45a4 100644
--- a/plugins/fn-string/functions.c
+++ b/plugins/fn-string/functions.c
@@ -1334,9 +1334,9 @@ static GnmFuncHelp const help_searchb[] = {
 					"string including the empty string. To search for "
 					"* or ?, precede the symbol with ~.")},
 	{ GNM_FUNC_HELP_NOTE, F_("This search is not case sensitive.") },
-	{ GNM_FUNC_HELP_NOTE, F_("If @{search} is not found, SEARCH returns #VALUE!") },
+	{ GNM_FUNC_HELP_NOTE, F_("If @{search} is not found, SEARCHB returns #VALUE!") },
 	{ GNM_FUNC_HELP_NOTE, F_("If @{start} is less than one or it is greater than "
-				 "the byte length of @{text}, SEARCH returns #VALUE!") },
+				 "the byte length of @{text}, SEARCHB returns #VALUE!") },
 	{ GNM_FUNC_HELP_NOTE, F_("The semantics of this function is subject to change as various applications implement it.")},
 	{ GNM_FUNC_HELP_EXCEL, F_("While this function is syntactically Excel compatible, "
 				  "the differences in the underlying text encoding will usually yield different results.")},
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]