summaryrefslogtreecommitdiff
path: root/Modules/atexitmodule.c
diff options
context:
space:
mode:
authorSkip Montanaro <skip@pobox.com>2007-08-06 20:59:28 +0000
committerSkip Montanaro <skip@pobox.com>2007-08-06 20:59:28 +0000
commit28a181cbe82bc79df3b881b79b19e12b2e39911b (patch)
tree2e3a5f4c8ac7da10a95fadb5de38fce48e4eb552 /Modules/atexitmodule.c
parente3b10f4c4ce753c8e6c93bffe31cf110b4984b60 (diff)
downloadcpython-git-28a181cbe82bc79df3b881b79b19e12b2e39911b.tar.gz
missing docstrings
Diffstat (limited to 'Modules/atexitmodule.c')
-rw-r--r--Modules/atexitmodule.c28
1 files changed, 23 insertions, 5 deletions
diff --git a/Modules/atexitmodule.c b/Modules/atexitmodule.c
index 64cd9a097b..60bb9328b1 100644
--- a/Modules/atexitmodule.c
+++ b/Modules/atexitmodule.c
@@ -145,6 +145,11 @@ atexit_register(PyObject *self, PyObject *args, PyObject *kwargs)
return func;
}
+PyDoc_STRVAR(atexit_run_exitfuncs__doc__,
+"_run_exitfuncs() -> None\n\
+\n\
+Run all registered exit functions.");
+
static PyObject *
atexit_run_exitfuncs(PyObject *self)
{
@@ -154,6 +159,11 @@ atexit_run_exitfuncs(PyObject *self)
Py_RETURN_NONE;
}
+PyDoc_STRVAR(atexit_clear__doc__,
+"_clear() -> None\n\
+\n\
+Clear the list of previously registered exit functions.");
+
static PyObject *
atexit_clear(PyObject *self)
{
@@ -172,6 +182,14 @@ atexit_clear(PyObject *self)
Py_RETURN_NONE;
}
+PyDoc_STRVAR(atexit_unregister__doc__,
+"unregister(func) -> None\n\
+\n\
+Unregister a exit function which was previously registered using\n\
+atexit.register\n\
+\n\
+ func - function to be unregistered");
+
static PyObject *
atexit_unregister(PyObject *self, PyObject *func)
{
@@ -197,11 +215,11 @@ static PyMethodDef atexit_methods[] = {
{"register", (PyCFunction) atexit_register, METH_VARARGS|METH_KEYWORDS,
atexit_register__doc__},
{"_clear", (PyCFunction) atexit_clear, METH_NOARGS,
- NULL},
+ atexit_clear__doc__},
{"unregister", (PyCFunction) atexit_unregister, METH_O,
- NULL},
+ atexit_unregister__doc__},
{"_run_exitfuncs", (PyCFunction) atexit_run_exitfuncs, METH_NOARGS,
- NULL},
+ atexit_run_exitfuncs__doc__},
{NULL, NULL} /* sentinel */
};
@@ -209,10 +227,10 @@ static PyMethodDef atexit_methods[] = {
/* Initialization function. */
PyDoc_STRVAR(atexit__doc__,
-"atexit.py - allow programmer to define multiple exit functions to be executed\
+"allow programmer to define multiple exit functions to be executed\
upon normal program termination.\n\
\n\
-One public function, register, is defined.\n\
+Two public functions, register and unregister, are defined.\n\
");
PyMODINIT_FUNC