summaryrefslogtreecommitdiffstats
path: root/Objects/moduleobject.c
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>2002-06-04 06:02:35 (GMT)
committerGuido van Rossum <guido@python.org>2002-06-04 06:02:35 (GMT)
commited3e09f28915eb382d8fdcab6734c382fd3f393c (patch)
tree744c4af67fc817ab1e37bdffa637ef613a09aa34 /Objects/moduleobject.c
parent2e4e02620bc118c57270519c7d5f3e76996b3841 (diff)
downloadcpython-ed3e09f28915eb382d8fdcab6734c382fd3f393c.zip
cpython-ed3e09f28915eb382d8fdcab6734c382fd3f393c.tar.gz
cpython-ed3e09f28915eb382d8fdcab6734c382fd3f393c.tar.bz2
Add a docstring to the module type.
Diffstat (limited to 'Objects/moduleobject.c')
-rw-r--r--Objects/moduleobject.c8
1 files changed, 7 insertions, 1 deletions
diff --git a/Objects/moduleobject.c b/Objects/moduleobject.c
index 9cd7f31..b46805d 100644
--- a/Objects/moduleobject.c
+++ b/Objects/moduleobject.c
@@ -209,6 +209,12 @@ module_traverse(PyModuleObject *m, visitproc visit, void *arg)
return 0;
}
+static char module_doc[] =
+"module(name[, doc])\n\
+\n\
+Create a module object.\n\
+The name must be a string; the optional doc argument can have any type.";
+
PyTypeObject PyModule_Type = {
PyObject_HEAD_INIT(&PyType_Type)
0, /* ob_size */
@@ -232,7 +238,7 @@ PyTypeObject PyModule_Type = {
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Py_TPFLAGS_BASETYPE, /* tp_flags */
- 0, /* tp_doc */
+ module_doc, /* tp_doc */
(traverseproc)module_traverse, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */