]> granicus.if.org Git - python/commitdiff
add some example docstrings using PyDoc_STR
authorSkip Montanaro <skip@pobox.com>
Wed, 14 Aug 2002 01:45:37 +0000 (01:45 +0000)
committerSkip Montanaro <skip@pobox.com>
Wed, 14 Aug 2002 01:45:37 +0000 (01:45 +0000)
Modules/xxsubtype.c

index c826b6e633c36f95401d5bdb4865f43bf3be4eec..ffbc72b1657ef7a0c4a5b8a54384d4ad6ac394d8 100644 (file)
@@ -65,17 +65,17 @@ spamlist_specialmeth(PyObject *self, PyObject *args, PyObject *kw)
 
 static PyMethodDef spamlist_methods[] = {
        {"getstate", (PyCFunction)spamlist_getstate, METH_VARARGS,
-               "getstate() -> state"},
+               PyDoc_STR("getstate() -> state")},
        {"setstate", (PyCFunction)spamlist_setstate, METH_VARARGS,
-               "setstate(state)"},
+               PyDoc_STR("setstate(state)")},
        /* These entries differ only in the flags; they are used by the tests
           in test.test_descr. */
        {"classmeth", (PyCFunction)spamlist_specialmeth,
                METH_VARARGS | METH_KEYWORDS | METH_CLASS,
-               "classmeth(*args, **kw)"},
+               PyDoc_STR("classmeth(*args, **kw)")},
        {"staticmeth", (PyCFunction)spamlist_specialmeth,
                METH_VARARGS | METH_KEYWORDS | METH_STATIC,
-               "staticmeth(*args, **kw)"},
+               PyDoc_STR("staticmeth(*args, **kw)")},
        {NULL,  NULL},
 };
 
@@ -98,7 +98,7 @@ spamlist_state_get(spamlistobject *self)
 
 static PyGetSetDef spamlist_getsets[] = {
        {"state", (getter)spamlist_state_get, NULL,
-        "an int variable for demonstration purposes"},
+        PyDoc_STR("an int variable for demonstration purposes")},
        {0}
 };
 
@@ -173,9 +173,9 @@ spamdict_setstate(spamdictobject *self, PyObject *args)
 
 static PyMethodDef spamdict_methods[] = {
        {"getstate", (PyCFunction)spamdict_getstate, METH_VARARGS,
-               "getstate() -> state"},
+               PyDoc_STR("getstate() -> state")},
        {"setstate", (PyCFunction)spamdict_setstate, METH_VARARGS,
-               "setstate(state)"},
+               PyDoc_STR("setstate(state)")},
        {NULL,  NULL},
 };
 
@@ -192,7 +192,7 @@ spamdict_init(spamdictobject *self, PyObject *args, PyObject *kwds)
 
 static PyMemberDef spamdict_members[] = {
        {"state", T_INT, offsetof(spamdictobject, state), READONLY,
-        "an int variable for demonstration purposes"},
+        PyDoc_STR("an int variable for demonstration purposes")},
        {0}
 };