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").

diff --git a/Modules/xxsubtype.c b/Modules/xxsubtype.c
index bbc5ea9b77b523f089ecc449a58047098b4d49a8..58024d11b04fb3ed3fba5ed2c68dee3f8a97fe44 100644 (file)
--- 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;