summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorTim Peters <tim.peters@gmail.com>2001-12-10 22:53:30 (GMT)
committerTim Peters <tim.peters@gmail.com>2001-12-10 22:53:30 (GMT)
commit65760b2173da008814ac0d207376e12527c5b3b2 (patch)
treef4b00edf20058cf848f955507133f817e84cd377 /Modules
parent2b29cb2593c2ca96eb4a0b32b1a6167ce5f18b7c (diff)
downloadcpython-65760b2173da008814ac0d207376e12527c5b3b2.zip
cpython-65760b2173da008814ac0d207376e12527c5b3b2.tar.gz
cpython-65760b2173da008814ac0d207376e12527c5b3b2.tar.bz2
Give xxsubtype a module docstring, so its oddball purpose is discoverable
from a prompt without searching the source code (there was an SF bug report about this, already closed ... "479568 xxsubtype builtin").
Diffstat (limited to 'Modules')
-rw-r--r--Modules/xxsubtype.c10
1 files changed, 8 insertions, 2 deletions
diff --git a/Modules/xxsubtype.c b/Modules/xxsubtype.c
index bbc5ea9..58024d1 100644
--- a/Modules/xxsubtype.c
+++ b/Modules/xxsubtype.c
@@ -1,7 +1,11 @@
#include "Python.h"
#include "structmember.h"
-/* Examples showing how to subtype the builtin list and dict types from C. */
+static char xxsubtype__doc__[] =
+"xxsubtype is an example module showing how to subtype builtin types from C.\n"
+"test_descr.py in the standard test suite requires it in order to complete.\n"
+"If you don't care about the examples, and don't intend to run the Python\n"
+"test suite, you can recompile Python without Modules/xxsubtype.c.";
/* spamlist -- a list subtype */
@@ -227,7 +231,9 @@ initxxsubtype(void)
{
PyObject *m, *d;
- m = Py_InitModule("xxsubtype", xxsubtype_functions);
+ m = Py_InitModule3("xxsubtype",
+ xxsubtype_functions,
+ xxsubtype__doc__);
if (m == NULL)
return;