Added Doc strings -- by Chris Petrilli.

1 files changed, 119 insertions, 17 deletions

diff --git a/Modules/cmathmodule.c b/Modules/cmathmodule.c
index 583a629..45dad11 100644
--- a/Modules/cmathmodule.c
+++ b/Modules/cmathmodule.c
@@ -48,6 +48,12 @@ static Py_complex c_acos(x)
 		    c_sqrt(c_diff(c_1,c_prod(x,x))))))));
 }
 
+static char c_acos_doc [] =
+"acos(x)\n\
+\n\
+Return the arc cosine of x.";
+
+
 static Py_complex c_acosh(x)
 	Py_complex x;
 {
@@ -55,6 +61,12 @@ static Py_complex c_acosh(x)
 		    c_sqrt(c_diff(c_1,c_prod(x,x))))));
 }
 
+static char c_acosh_doc [] =
+"acosh(x)\n\
+\n\
+Return the hyperbolic cosine of x.";
+
+
 static Py_complex c_asin(x)
 	Py_complex x;
 {
@@ -62,24 +74,48 @@ static Py_complex c_asin(x)
 		    c_sqrt(c_diff(c_1,c_prod(x,x)))))));
 }
 
+static char c_asin_doc [] =
+"asin(x)\n\
+\n\
+Return the arc sine of x.";
+
+
 static Py_complex c_asinh(x)
 	Py_complex x;
 {
 	return c_neg(c_log(c_diff(c_sqrt(c_sum(c_1,c_prod(x,x))),x)));
 }
 
+static char c_asinh_doc [] =
+"asinh(x)\n\
+\n\
+Return the hyperbolic arc sine of x.";
+
+
 static Py_complex c_atan(x)
 	Py_complex x;
 {
 	return c_prod(c_i2,c_log(c_quot(c_sum(c_i,x),c_diff(c_i,x))));
 }
 
+static char c_atan_doc [] =
+"atan(x)\n\
+\n\
+Return the arc tangent of x.";
+
+
 static Py_complex c_atanh(x)
 	Py_complex x;
 {
 	return c_prod(c_half,c_log(c_quot(c_sum(c_1,x),c_diff(c_1,x))));
 }
 
+static char c_atanh_doc [] =
+"atanh(x)\n\
+\n\
+Return the hyperbolic arc tangent of x.";
+
+
 static Py_complex c_cos(x)
 	Py_complex x;
 {
@@ -89,6 +125,12 @@ static Py_complex c_cos(x)
 	return r;
 }
 
+static char c_cos_doc [] =
+"cos(x)\n\
+\n\
+Return the cosine of x.";
+
+
 static Py_complex c_cosh(x)
 	Py_complex x;
 {
@@ -98,6 +140,12 @@ static Py_complex c_cosh(x)
 	return r;
 }
 
+static char c_cosh_doc [] =
+"cosh(x)\n\
+\n\
+Return the hyperbolic cosine of x.";
+
+
 static Py_complex c_exp(x)
 	Py_complex x;
 {
@@ -108,6 +156,12 @@ static Py_complex c_exp(x)
 	return r;
 }
 
+static char c_exp_doc [] =
+"exp(x)\n\
+\n\
+Return the exponential value e**x.";
+
+
 static Py_complex c_log(x)
 	Py_complex x;
 {
@@ -118,6 +172,12 @@ static Py_complex c_log(x)
 	return r;
 }
 
+static char c_log_doc [] =
+"log(x)\n\
+\n\
+Return the natural logarithm of x.";
+
+
 static Py_complex c_log10(x)
 	Py_complex x;
 {
@@ -128,6 +188,13 @@ static Py_complex c_log10(x)
 	return r;
 }
 
+static char c_log10_doc [] =
+"log10(x)\n\
+\n\
+Return the base-10 logarithm of x.";
+
+
+/* internal function not available from Python */
 static Py_complex c_prodi(x)
      Py_complex x;
 {
@@ -137,6 +204,7 @@ static Py_complex c_prodi(x)
 	return r;
 }
 
+
 static Py_complex c_sin(x)
 	Py_complex x;
 {
@@ -146,6 +214,12 @@ static Py_complex c_sin(x)
 	return r;
 }
 
+static char c_sin_doc [] =
+"sin(x)\n\
+\n\
+Return the sine of x.";
+
+
 static Py_complex c_sinh(x)
 	Py_complex x;
 {
@@ -155,6 +229,12 @@ static Py_complex c_sinh(x)
 	return r;
 }
 
+static char c_sinh_doc [] =
+"sinh(x)\n\
+\n\
+Return the hyperbolic sine of x.";
+
+
 static Py_complex c_sqrt(x)
 	Py_complex x;
 {
@@ -181,6 +261,12 @@ static Py_complex c_sqrt(x)
 	return r;
 }
 
+static char c_sqrt_doc [] =
+"sqrt(x)\n\
+\n\
+Return the square root of x.";
+
+
 static Py_complex c_tan(x)
 	Py_complex x;
 {
@@ -202,6 +288,12 @@ static Py_complex c_tan(x)
 	return r;
 }
 
+static char c_tan_doc [] =
+"tan(x)\n\
+\n\
+Return the tangent of x.";
+
+
 static Py_complex c_tanh(x)
 	Py_complex x;
 {
@@ -223,6 +315,11 @@ static Py_complex c_tanh(x)
 	return r;
 }
 
+static char c_tanh_doc [] =
+"tanh(x)\n\
+\n\
+Return the hyperbolic tangent of x.";
+
 
 /* And now the glue to make them available from Python: */
 
@@ -281,23 +378,28 @@ FUNC1(cmath_tan, c_tan)
 FUNC1(cmath_tanh, c_tanh)
 
 
+static char module_doc [] =
+"This module is always available. It provides access to mathematical\n\
+functions for complex numbers.";
+
+
 static PyMethodDef cmath_methods[] = {
-	{"acos", cmath_acos, 1},
-	{"acosh", cmath_acosh, 1},
-	{"asin", cmath_asin, 1},
-	{"asinh", cmath_asinh, 1},
-	{"atan", cmath_atan, 1},
-	{"atanh", cmath_atanh, 1},
-	{"cos", cmath_cos, 1},
-	{"cosh", cmath_cosh, 1},
-	{"exp", cmath_exp, 1},
-	{"log", cmath_log, 1},
-	{"log10", cmath_log10, 1},
-	{"sin", cmath_sin, 1},
-	{"sinh", cmath_sinh, 1},
-	{"sqrt", cmath_sqrt, 1},
-	{"tan", cmath_tan, 1},
-	{"tanh", cmath_tanh, 1},
+	{"acos", cmath_acos, 1, c_acos_doc},
+	{"acosh", cmath_acosh, 1, c_acosh_doc},
+	{"asin", cmath_asin, 1, c_asin_doc},
+	{"asinh", cmath_asinh, 1, c_asinh_doc},
+	{"atan", cmath_atan, 1, c_atan_doc},
+	{"atanh", cmath_atanh, 1, c_atanh_doc},
+	{"cos", cmath_cos, 1, c_cos_doc},
+	{"cosh", cmath_cosh, 1, c_cosh_doc},
+	{"exp", cmath_exp, 1, c_exp_doc},
+	{"log", cmath_log, 1, c_log_doc},
+	{"log10", cmath_log10, 1, c_log10_doc},
+	{"sin", cmath_sin, 1, c_sin_doc},
+	{"sinh", cmath_sinh, 1, c_sinh_doc},
+	{"sqrt", cmath_sqrt, 1, c_sqrt_doc},
+	{"tan", cmath_tan, 1, c_tan_doc},
+	{"tanh", cmath_tanh, 1, c_tanh_doc},
 	{NULL,		NULL}		/* sentinel */
 };
 
@@ -306,7 +408,7 @@ initcmath()
 {
 	PyObject *m, *d, *v;
 	
-	m = Py_InitModule("cmath", cmath_methods);
+	m = Py_InitModule3("cmath", cmath_methods, module_doc);
 	d = PyModule_GetDict(m);
 	PyDict_SetItemString(d, "pi",
 			     v = PyFloat_FromDouble(atan(1.0) * 4.0));