From: Guido van Rossum <guido@python.org>
Date: Tue, 4 Jun 2002 06:02:35 +0000 (+0000)
Subject: Add a docstring to the module type.
X-Git-Tag: v2.3c1~5493
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ed3e09f28915eb382d8fdcab6734c382fd3f393c;p=python

Add a docstring to the module type.
---

diff --git a/Objects/moduleobject.c b/Objects/moduleobject.c
index 9cd7f31d38..b46805d34b 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 */