Skip to content

GitLab

gnumeric
gnumeric
Commit e4971b92 authored by Kwok-Koon Cheung's avatar Kwok-Koon Cheung
Browse files
Options

Various typo and minor fixes in function descriptions. 


	* fn-database.c, fn-date.c, fn-eng.c, fn-information.c, fn-math.c,
	  fn-stat.c: Various typo and minor fixes in function descriptions.
parent 74e4bbec
Hide whitespace changes
Inline Side-by-side
Showing with 75 additions and 66 deletions
plugins/fn-database/functions.c
View file @ e4971b92
......@@ -706,6 +706,7 @@ static char *help_dget = {
"error. "
"If more than one items match the conditions, DGET returns #NUM! "
"error. "
"\n"
"@EXAMPLES=\n"
"DGET(A1:C7, \"Salary\", A9:A10) equals 34323.\n"
"DGET(A1:C7, \"Name\", A9:A10) equals \"Clark\".\n"
......
plugins/fn-date/functions.c
View file @ e4971b92
......@@ -997,7 +997,7 @@ static char * help_networkdays = {
"NETWORKDAYS returns the number of non-weekend non-holidays between "
"@start_date and @end_date. Holidays optionally supplied in @holidays."
"\n"
"Returns #NUM if start_date or end_date are invalid.\n"
"Returns #NUM! if start_date or end_date are invalid.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......
plugins/fn-eng/functions.c
View file @ e4971b92
......@@ -1688,7 +1688,7 @@ static char *help_delta = {
"@DESCRIPTION="
"DELTA function tests for numerical equivalence of two "
"arguments returning 1 in case of equality. "
"arguments, returning 1 in case of equality. "
"@y is optional, and defaults to 0."
"\n"
"If either argument is non-numeric returns a #VALUE! error.\n"
......@@ -1743,7 +1743,7 @@ static char *help_gestep = {
"@SYNTAX=GESTEP(x[,y])\n"
"@DESCRIPTION="
"GESTEP function test for if @x is >= @y, returning 1 if it "
"is so, and 0 otherwise @y is optional, and defaults to 0."
"is so, and 0 otherwise. @y is optional, and defaults to 0."
"\n"
"If either argument is non-numeric returns a #VALUE! error.\n"
"This function is Excel compatible."
......
plugins/fn-info/functions.c
View file @ e4971b92
......@@ -581,9 +581,9 @@ static char *help_error_type = {
"#DIV/0! 2\n"
"#VALUE! 3\n"
"#REF! 4\n"
"#NAME! 5\n"
"#NAME? 5\n"
"#NUM! 6\n"
"#NA! 7\n"
"#N/A 7\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......
plugins/fn-math/functions.c
View file @ e4971b92
......@@ -180,7 +180,7 @@ static char *help_lcm = {
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
"LCM(2,13) equlas to 26.\n"
"LCM(2,13) equals to 26.\n"
"LCM(4,7,5) equals to 140.\n"
"\n"
"@SEEALSO=GCD")
......@@ -255,7 +255,7 @@ static char *help_acos = {
"@DESCRIPTION="
"ACOS function calculates the arc cosine of @x; that "
"is the value whose cosine is @x. If @x falls outside the "
"range -1 to 1, ACOS fails and returns the NUM! error. "
"range -1 to 1, ACOS fails and returns the #NUM! error. "
"The value it returns is in radians.\n"
"This function is Excel compatible."
"\n"
......@@ -287,7 +287,7 @@ static char *help_acosh = {
"@DESCRIPTION="
"ACOSH function calculates the inverse hyperbolic "
"cosine of @x; that is the value whose hyperbolic cosine is "
"@x. If @x is less than 1.0, ACOSH() returns the NUM! error.\n"
"@x. If @x is less than 1.0, ACOSH() returns the #NUM! error.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......@@ -318,7 +318,7 @@ static char *help_asin = {
"@DESCRIPTION="
"ASIN function calculates the arc sine of @x; that is "
"the value whose sine is @x. If @x falls outside the range "
"-1 to 1, ASIN fails and returns the NUM! error.\n"
"-1 to 1, ASIN fails and returns the #NUM! error.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......@@ -399,7 +399,7 @@ static char *help_atanh = {
"ATANH function calculates the inverse hyperbolic tangent "
"of @x; that is the value whose hyperbolic tangent is @x. "
"If the absolute value of @x is greater than 1.0, ATANH "
"returns NUM! error.\n"
"returns #NUM! error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -1818,7 +1818,7 @@ static char *help_factdouble = {
"@DESCRIPTION="
"FACTDOUBLE function returns the double factorial "
"of a @number. "
"of a @number, i.e., x!!."
"\n"
"If @number is not an integer, it is truncated. "
"If @number is negative FACTDOUBLE returns #NUM! error.\n"
......@@ -1852,11 +1852,12 @@ gnumeric_factdouble (FunctionEvalInfo *ei, Value **argv)
static char *help_quotient = {
N_("@FUNCTION=QUOTIENT\n"
"@SYNTAX=QUOTIENT(num,den)\n"
"@SYNTAX=QUOTIENT(numerator,denumerator)\n"
"@DESCRIPTION="
"QUOTIENT function returns the integer portion "
"of a division. @num is the divided and @den is the divisor.\n"
"of a division. @numerator is the divided number and \n"
"@denumerator is the divisor.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......@@ -1950,7 +1951,7 @@ static char *help_randbetween = {
"@DESCRIPTION="
"RANDBETWEEN function returns a random integer number "
"between @bottom and @top.\n"
"between and including @bottom and @top.\n"
"If @bottom or @top is non-integer, they are truncated. "
"If @bottom > @top, RANDBETWEEN returns #NUM! error.\n"
"This function is Excel compatible. "
......@@ -1983,7 +1984,7 @@ static char *help_rounddown = {
"@SYNTAX=ROUNDDOWN(number[,digits])\n"
"@DESCRIPTION="
"ROUNDDOWN function rounds a given @number down, towards zero. "
"ROUNDDOWN function rounds a given @number down. "
"@number is the number you want rounded down and @digits is the "
"number of digits to which you want to round that number. "
"\n"
......@@ -2068,7 +2069,7 @@ static char *help_roundup = {
"@SYNTAX=ROUNDUP(number[,digits])\n"
"@DESCRIPTION="
"ROUNDUP function rounds a given number up, away from zero. "
"ROUNDUP function rounds a given number up. "
"@number is the number you want rounded up and @digits is the "
"number of digits to which you want to round that number. "
"\n"
......@@ -2437,7 +2438,7 @@ static char *help_sumx2my2 = {
"Strings and empty cells are simply ignored."
"\n"
"If @array1 and @array2 have different number of data points, "
"SUMX2MY2 returns #N/A! error.\n"
"SUMX2MY2 returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2550,7 +2551,7 @@ static char *help_sumx2py2 = {
"Strings and empty cells are simply ignored."
"\n"
"If @array1 and @array2 have different number of data points, "
"SUMX2PY2 returns #N/A! error.\n"
"SUMX2PY2 returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2662,7 +2663,7 @@ static char *help_sumxmy2 = {
"Strings and empty cells are simply ignored."
"\n"
"If @array1 and @array2 have different number of data points, "
"SUMXMY2 returns #N/A! error.\n"
"SUMXMY2 returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2850,7 +2851,7 @@ static char *help_seriessum = {
"@DESCRIPTION="
"SERIESSUM function returns the sum of a power series. @x is "
"the base of the power serie, @n is the initial power to raise @x, "
"the base of the power series, @n is the initial power to raise @x, "
"@m is the increment to the power for each term in the series, and "
"@coefficients is the coefficents by which each successive power "
"of @x is multiplied.\n"
......
plugins/fn-stat/functions.c
View file @ e4971b92
......@@ -714,7 +714,7 @@ static char *help_mode = {
"\n"
"Strings and empty cells are simply ignored. "
"If the data set does not contain any duplicates MODE returns "
"#N/A! error.\n"
"#N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2459,7 +2459,7 @@ callback_function_list (Sheet *sheet, int col, int row,
static char *help_prob = {
N_("@FUNCTION=PROB\n"
"@SYNTAX=PROB(range_x,prob_range,lower_limit[,upper_limit])\n"
"@SYNTAX=PROB(x_range,prob_range,lower_limit[,upper_limit])\n"
"@DESCRIPTION="
"PROB function returns the probability that values in a range or "
......@@ -2472,7 +2472,7 @@ static char *help_prob = {
"If any value in @prob_range is <=0 or > 1, PROB returns #NUM! "
"error. "
"If @x_range and @prob_range contain a different number of data "
"entries, PROB returns #N/A! error.\n"
"entries, PROB returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2560,7 +2560,7 @@ static char *help_steyx = {
"y-value for each x in the regression."
"\n"
"If @known_y's and @known_x's are empty or have a different number "
"of arguments then STEYX returns #N/A! error.\n"
"of arguments then STEYX returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2838,7 +2838,7 @@ static char *help_maxa = {
"@EXAMPLES=\n"
"Let us assume that the cells A1, A2, ..., A5 contain numbers "
"and strings 11.4, 17.3, \"missing\", 25.9, and 40.1. Then\n"
"MINA(A1:A5) equals 0.\n"
"MAXA(A1:A5) equals 40.1.\n"
"\n"
"@SEEALSO=MAX,MINA")
};
......@@ -2863,17 +2863,17 @@ static char *help_mina = {
"@DESCRIPTION="
"MINA returns the smallest value of the given arguments. Numbers, "
"text and logical values are included in the calculation, blank "
"cells are not. If the cell contains text or the argument evaluates "
"to FALSE, it is counted as value zero (0). If the argument "
"evaluates to TRUE, it is counted as one (1). Note that empty "
"cells are not counted.\n"
"text and logical values are included in the calculation too. "
"If the cell contains text or the argument evaluates to FALSE, "
"it is counted as value zero (0). If the argument evaluates to "
"TRUE, it is counted as one (1). Note that empty cells are not "
"counted.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
"Let us assume that the cells A1, A2, ..., A5 contain numbers "
"and strings 11.4, 17.3, \"missing\", 25.9, and 40.1. Then\n"
"MAXA(A1:A5) equals 40.1.\n"
"MINA(A1:A5) equals 0.\n"
"\n"
"@SEEALSO=MIN,MAXA")
};
......@@ -4308,7 +4308,7 @@ static char *help_forecast = {
"future value is a y-value for a given x-value (@x). "
"\n"
"If @known_x or @known_y contains no data entries or different "
"number of data entries, FORECAST returns #N/A! error. "
"number of data entries, FORECAST returns #N/A error. "
"If the variance of the @known_x is zero, FORECAST returns #DIV/0 "
"error.\n"
"This function is Excel compatible."
......@@ -4378,7 +4378,7 @@ static char *help_intercept = {
"regression line intersects the y-axis. "
"\n"
"If @known_x or @known_y contains no data entries or different "
"number of data entries, INTERCEPT returns #N/A! error. "
"number of data entries, INTERCEPT returns #N/A error. "
"If the variance of the @known_x is zero, INTERCEPT returns #DIV/0 "
"error.\n"
"This function is Excel compatible."
......
src/functions/ChangeLog
View file @ e4971b92
2002-01-17 Abel Cheung <maddog@linux.org.hk>
* fn-database.c, fn-date.c, fn-eng.c, fn-information.c, fn-math.c,
fn-stat.c: Various typo and minor fixes in function descriptions.
2002-01-16 Jon K Hellan <hellan@acm.org>
* fn-sheet.c (gnumeric_version): Return string as documented, not
......
src/functions/fn-database.c
View file @ e4971b92
......@@ -706,6 +706,7 @@ static char *help_dget = {
"error. "
"If more than one items match the conditions, DGET returns #NUM! "
"error. "
"\n"
"@EXAMPLES=\n"
"DGET(A1:C7, \"Salary\", A9:A10) equals 34323.\n"
"DGET(A1:C7, \"Name\", A9:A10) equals \"Clark\".\n"
......
src/functions/fn-date.c
View file @ e4971b92
......@@ -997,7 +997,7 @@ static char * help_networkdays = {
"NETWORKDAYS returns the number of non-weekend non-holidays between "
"@start_date and @end_date. Holidays optionally supplied in @holidays."
"\n"
"Returns #NUM if start_date or end_date are invalid.\n"
"Returns #NUM! if start_date or end_date are invalid.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......
src/functions/fn-eng.c
View file @ e4971b92
......@@ -1688,7 +1688,7 @@ static char *help_delta = {
"@DESCRIPTION="
"DELTA function tests for numerical equivalence of two "
"arguments returning 1 in case of equality. "
"arguments, returning 1 in case of equality. "
"@y is optional, and defaults to 0."
"\n"
"If either argument is non-numeric returns a #VALUE! error.\n"
......@@ -1743,7 +1743,7 @@ static char *help_gestep = {
"@SYNTAX=GESTEP(x[,y])\n"
"@DESCRIPTION="
"GESTEP function test for if @x is >= @y, returning 1 if it "
"is so, and 0 otherwise @y is optional, and defaults to 0."
"is so, and 0 otherwise. @y is optional, and defaults to 0."
"\n"
"If either argument is non-numeric returns a #VALUE! error.\n"
"This function is Excel compatible."
......
src/functions/fn-information.c
View file @ e4971b92
......@@ -581,9 +581,9 @@ static char *help_error_type = {
"#DIV/0! 2\n"
"#VALUE! 3\n"
"#REF! 4\n"
"#NAME! 5\n"
"#NAME? 5\n"
"#NUM! 6\n"
"#NA! 7\n"
"#N/A 7\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......
src/functions/fn-math.c
View file @ e4971b92
......@@ -180,7 +180,7 @@ static char *help_lcm = {
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
"LCM(2,13) equlas to 26.\n"
"LCM(2,13) equals to 26.\n"
"LCM(4,7,5) equals to 140.\n"
"\n"
"@SEEALSO=GCD")
......@@ -255,7 +255,7 @@ static char *help_acos = {
"@DESCRIPTION="
"ACOS function calculates the arc cosine of @x; that "
"is the value whose cosine is @x. If @x falls outside the "
"range -1 to 1, ACOS fails and returns the NUM! error. "
"range -1 to 1, ACOS fails and returns the #NUM! error. "
"The value it returns is in radians.\n"
"This function is Excel compatible."
"\n"
......@@ -287,7 +287,7 @@ static char *help_acosh = {
"@DESCRIPTION="
"ACOSH function calculates the inverse hyperbolic "
"cosine of @x; that is the value whose hyperbolic cosine is "
"@x. If @x is less than 1.0, ACOSH() returns the NUM! error.\n"
"@x. If @x is less than 1.0, ACOSH() returns the #NUM! error.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......@@ -318,7 +318,7 @@ static char *help_asin = {
"@DESCRIPTION="
"ASIN function calculates the arc sine of @x; that is "
"the value whose sine is @x. If @x falls outside the range "
"-1 to 1, ASIN fails and returns the NUM! error.\n"
"-1 to 1, ASIN fails and returns the #NUM! error.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......@@ -399,7 +399,7 @@ static char *help_atanh = {
"ATANH function calculates the inverse hyperbolic tangent "
"of @x; that is the value whose hyperbolic tangent is @x. "
"If the absolute value of @x is greater than 1.0, ATANH "
"returns NUM! error.\n"
"returns #NUM! error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -1818,7 +1818,7 @@ static char *help_factdouble = {
"@DESCRIPTION="
"FACTDOUBLE function returns the double factorial "
"of a @number. "
"of a @number, i.e., x!!."
"\n"
"If @number is not an integer, it is truncated. "
"If @number is negative FACTDOUBLE returns #NUM! error.\n"
......@@ -1852,11 +1852,12 @@ gnumeric_factdouble (FunctionEvalInfo *ei, Value **argv)
static char *help_quotient = {
N_("@FUNCTION=QUOTIENT\n"
"@SYNTAX=QUOTIENT(num,den)\n"
"@SYNTAX=QUOTIENT(numerator,denumerator)\n"
"@DESCRIPTION="
"QUOTIENT function returns the integer portion "
"of a division. @num is the divided and @den is the divisor.\n"
"of a division. @numerator is the divided number and \n"
"@denumerator is the divisor.\n"
"This function is Excel compatible. "
"\n"
"@EXAMPLES=\n"
......@@ -1950,7 +1951,7 @@ static char *help_randbetween = {
"@DESCRIPTION="
"RANDBETWEEN function returns a random integer number "
"between @bottom and @top.\n"
"between and including @bottom and @top.\n"
"If @bottom or @top is non-integer, they are truncated. "
"If @bottom > @top, RANDBETWEEN returns #NUM! error.\n"
"This function is Excel compatible. "
......@@ -1983,7 +1984,7 @@ static char *help_rounddown = {
"@SYNTAX=ROUNDDOWN(number[,digits])\n"
"@DESCRIPTION="
"ROUNDDOWN function rounds a given @number down, towards zero. "
"ROUNDDOWN function rounds a given @number down. "
"@number is the number you want rounded down and @digits is the "
"number of digits to which you want to round that number. "
"\n"
......@@ -2068,7 +2069,7 @@ static char *help_roundup = {
"@SYNTAX=ROUNDUP(number[,digits])\n"
"@DESCRIPTION="
"ROUNDUP function rounds a given number up, away from zero. "
"ROUNDUP function rounds a given number up. "
"@number is the number you want rounded up and @digits is the "
"number of digits to which you want to round that number. "
"\n"
......@@ -2437,7 +2438,7 @@ static char *help_sumx2my2 = {
"Strings and empty cells are simply ignored."
"\n"
"If @array1 and @array2 have different number of data points, "
"SUMX2MY2 returns #N/A! error.\n"
"SUMX2MY2 returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2550,7 +2551,7 @@ static char *help_sumx2py2 = {
"Strings and empty cells are simply ignored."
"\n"
"If @array1 and @array2 have different number of data points, "
"SUMX2PY2 returns #N/A! error.\n"
"SUMX2PY2 returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2662,7 +2663,7 @@ static char *help_sumxmy2 = {
"Strings and empty cells are simply ignored."
"\n"
"If @array1 and @array2 have different number of data points, "
"SUMXMY2 returns #N/A! error.\n"
"SUMXMY2 returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2850,7 +2851,7 @@ static char *help_seriessum = {
"@DESCRIPTION="
"SERIESSUM function returns the sum of a power series. @x is "
"the base of the power serie, @n is the initial power to raise @x, "
"the base of the power series, @n is the initial power to raise @x, "
"@m is the increment to the power for each term in the series, and "
"@coefficients is the coefficents by which each successive power "
"of @x is multiplied.\n"
......
src/functions/fn-stat.c
View file @ e4971b92
......@@ -714,7 +714,7 @@ static char *help_mode = {
"\n"
"Strings and empty cells are simply ignored. "
"If the data set does not contain any duplicates MODE returns "
"#N/A! error.\n"
"#N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2459,7 +2459,7 @@ callback_function_list (Sheet *sheet, int col, int row,
static char *help_prob = {
N_("@FUNCTION=PROB\n"
"@SYNTAX=PROB(range_x,prob_range,lower_limit[,upper_limit])\n"
"@SYNTAX=PROB(x_range,prob_range,lower_limit[,upper_limit])\n"
"@DESCRIPTION="
"PROB function returns the probability that values in a range or "
......@@ -2472,7 +2472,7 @@ static char *help_prob = {
"If any value in @prob_range is <=0 or > 1, PROB returns #NUM! "
"error. "
"If @x_range and @prob_range contain a different number of data "
"entries, PROB returns #N/A! error.\n"
"entries, PROB returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2560,7 +2560,7 @@ static char *help_steyx = {
"y-value for each x in the regression."
"\n"
"If @known_y's and @known_x's are empty or have a different number "
"of arguments then STEYX returns #N/A! error.\n"
"of arguments then STEYX returns #N/A error.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
......@@ -2838,7 +2838,7 @@ static char *help_maxa = {
"@EXAMPLES=\n"
"Let us assume that the cells A1, A2, ..., A5 contain numbers "
"and strings 11.4, 17.3, \"missing\", 25.9, and 40.1. Then\n"
"MINA(A1:A5) equals 0.\n"
"MAXA(A1:A5) equals 40.1.\n"
"\n"
"@SEEALSO=MAX,MINA")
};
......@@ -2863,17 +2863,17 @@ static char *help_mina = {
"@DESCRIPTION="
"MINA returns the smallest value of the given arguments. Numbers, "
"text and logical values are included in the calculation, blank "
"cells are not. If the cell contains text or the argument evaluates "
"to FALSE, it is counted as value zero (0). If the argument "
"evaluates to TRUE, it is counted as one (1). Note that empty "
"cells are not counted.\n"
"text and logical values are included in the calculation too. "
"If the cell contains text or the argument evaluates to FALSE, "
"it is counted as value zero (0). If the argument evaluates to "
"TRUE, it is counted as one (1). Note that empty cells are not "
"counted.\n"
"This function is Excel compatible."
"\n"
"@EXAMPLES=\n"
"Let us assume that the cells A1, A2, ..., A5 contain numbers "
"and strings 11.4, 17.3, \"missing\", 25.9, and 40.1. Then\n"
"MAXA(A1:A5) equals 40.1.\n"
"MINA(A1:A5) equals 0.\n"
"\n"
"@SEEALSO=MIN,MAXA")
};
......@@ -4308,7 +4308,7 @@ static char *help_forecast = {
"future value is a y-value for a given x-value (@x). "
"\n"
"If @known_x or @known_y contains no data entries or different "
"number of data entries, FORECAST returns #N/A! error. "
"number of data entries, FORECAST returns #N/A error. "
"If the variance of the @known_x is zero, FORECAST returns #DIV/0 "
"error.\n"
"This function is Excel compatible."
......@@ -4378,7 +4378,7 @@ static char *help_intercept = {
"regression line intersects the y-axis. "
"\n"
"If @known_x or @known_y contains no data entries or different "
"number of data entries, INTERCEPT returns #N/A! error. "
"number of data entries, INTERCEPT returns #N/A error. "
"If the variance of the @known_x is zero, INTERCEPT returns #DIV/0 "
"error.\n"
"This function is Excel compatible."
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment