mirror of
https://github.com/python/cpython.git
synced 2025-10-17 12:18:23 +00:00
Patch #568124: Add doc string macros.
This commit is contained in:
parent
654c11ee3a
commit
14f8b4cfcb
63 changed files with 1509 additions and 1625 deletions
|
@ -85,13 +85,13 @@ math_2(PyObject *args, double (*func) (double, double), char *argsfmt)
|
|||
static PyObject * math_##funcname(PyObject *self, PyObject *args) { \
|
||||
return math_1(args, func, "d:" #funcname); \
|
||||
}\
|
||||
static char math_##funcname##_doc [] = docstring;
|
||||
PyDoc_STRVAR(math_##funcname##_doc, docstring);
|
||||
|
||||
#define FUNC2(funcname, func, docstring) \
|
||||
static PyObject * math_##funcname(PyObject *self, PyObject *args) { \
|
||||
return math_2(args, func, "dd:" #funcname); \
|
||||
}\
|
||||
static char math_##funcname##_doc [] = docstring;
|
||||
PyDoc_STRVAR(math_##funcname##_doc, docstring);
|
||||
|
||||
FUNC1(acos, acos,
|
||||
"acos(x)\n\nReturn the arc cosine (measured in radians) of x.")
|
||||
|
@ -155,12 +155,12 @@ math_frexp(PyObject *self, PyObject *args)
|
|||
return Py_BuildValue("(di)", x, i);
|
||||
}
|
||||
|
||||
static char math_frexp_doc [] =
|
||||
PyDoc_STRVAR(math_frexp_doc,
|
||||
"frexp(x)\n"
|
||||
"\n"
|
||||
"Return the mantissa and exponent of x, as pair (m, e).\n"
|
||||
"m is a float and e is an int, such that x = m * 2.**e.\n"
|
||||
"If x is 0, m and e are both 0. Else 0.5 <= abs(m) < 1.0.";
|
||||
"If x is 0, m and e are both 0. Else 0.5 <= abs(m) < 1.0.");
|
||||
|
||||
static PyObject *
|
||||
math_ldexp(PyObject *self, PyObject *args)
|
||||
|
@ -180,8 +180,8 @@ math_ldexp(PyObject *self, PyObject *args)
|
|||
return PyFloat_FromDouble(x);
|
||||
}
|
||||
|
||||
static char math_ldexp_doc [] =
|
||||
"ldexp(x, i) -> x * (2**i)";
|
||||
PyDoc_STRVAR(math_ldexp_doc,
|
||||
"ldexp(x, i) -> x * (2**i)");
|
||||
|
||||
static PyObject *
|
||||
math_modf(PyObject *self, PyObject *args)
|
||||
|
@ -206,11 +206,11 @@ math_modf(PyObject *self, PyObject *args)
|
|||
return Py_BuildValue("(dd)", x, y);
|
||||
}
|
||||
|
||||
static char math_modf_doc [] =
|
||||
PyDoc_STRVAR(math_modf_doc,
|
||||
"modf(x)\n"
|
||||
"\n"
|
||||
"Return the fractional and integer parts of x. Both results carry the sign\n"
|
||||
"of x. The integer part is returned as a real.";
|
||||
"of x. The integer part is returned as a real.");
|
||||
|
||||
/* A decent logarithm is easy to compute even for huge longs, but libm can't
|
||||
do that by itself -- loghelper can. func is log or log10, and name is
|
||||
|
@ -262,8 +262,8 @@ math_log(PyObject *self, PyObject *args)
|
|||
return loghelper(args, log, "log");
|
||||
}
|
||||
|
||||
static char math_log_doc[] =
|
||||
"log(x) -> the natural logarithm (base e) of x.";
|
||||
PyDoc_STRVAR(math_log_doc,
|
||||
"log(x) -> the natural logarithm (base e) of x.");
|
||||
|
||||
static PyObject *
|
||||
math_log10(PyObject *self, PyObject *args)
|
||||
|
@ -271,8 +271,8 @@ math_log10(PyObject *self, PyObject *args)
|
|||
return loghelper(args, log10, "log10");
|
||||
}
|
||||
|
||||
static char math_log10_doc[] =
|
||||
"log10(x) -> the base 10 logarithm of x.";
|
||||
PyDoc_STRVAR(math_log10_doc,
|
||||
"log10(x) -> the base 10 logarithm of x.");
|
||||
|
||||
static const double degToRad = 3.141592653589793238462643383 / 180.0;
|
||||
|
||||
|
@ -285,8 +285,8 @@ math_degrees(PyObject *self, PyObject *args)
|
|||
return PyFloat_FromDouble(x / degToRad);
|
||||
}
|
||||
|
||||
static char math_degrees_doc[] =
|
||||
"degrees(x) -> converts angle x from radians to degrees";
|
||||
PyDoc_STRVAR(math_degrees_doc,
|
||||
"degrees(x) -> converts angle x from radians to degrees");
|
||||
|
||||
static PyObject *
|
||||
math_radians(PyObject *self, PyObject *args)
|
||||
|
@ -297,8 +297,8 @@ math_radians(PyObject *self, PyObject *args)
|
|||
return PyFloat_FromDouble(x * degToRad);
|
||||
}
|
||||
|
||||
static char math_radians_doc[] =
|
||||
"radians(x) -> converts angle x from degrees to radians";
|
||||
PyDoc_STRVAR(math_radians_doc,
|
||||
"radians(x) -> converts angle x from degrees to radians");
|
||||
|
||||
static PyMethodDef math_methods[] = {
|
||||
{"acos", math_acos, METH_VARARGS, math_acos_doc},
|
||||
|
@ -330,9 +330,9 @@ static PyMethodDef math_methods[] = {
|
|||
};
|
||||
|
||||
|
||||
static char module_doc [] =
|
||||
PyDoc_STRVAR(module_doc,
|
||||
"This module is always available. It provides access to the\n"
|
||||
"mathematical functions defined by the C standard.";
|
||||
"mathematical functions defined by the C standard.");
|
||||
|
||||
DL_EXPORT(void)
|
||||
initmath(void)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue