diff options
author | Tim Peters <tim.peters@gmail.com> | 2000-12-13 23:18:45 +0000 |
---|---|---|
committer | Tim Peters <tim.peters@gmail.com> | 2000-12-13 23:18:45 +0000 |
commit | 990564cf57cd4dade02257ad966b4298efb962bd (patch) | |
tree | ef8b7c457f1c41a1ddf5bbfdabbd4509844d9c7e /Objects/dictobject.c | |
parent | 5defcd7a4cee768ea71da23fa7fd901d66474afc (diff) | |
download | cpython-990564cf57cd4dade02257ad966b4298efb962bd.tar.gz |
Add long-overdue docstrings to dict methods.
Diffstat (limited to 'Objects/dictobject.c')
-rw-r--r-- | Objects/dictobject.c | 64 |
1 files changed, 53 insertions, 11 deletions
diff --git a/Objects/dictobject.c b/Objects/dictobject.c index 35b1b2b97c..42e270edc1 100644 --- a/Objects/dictobject.c +++ b/Objects/dictobject.c @@ -1230,18 +1230,60 @@ dict_tp_clear(PyObject *op) return 0; } + +static char has_key__doc__[] = +"D.has_key(k) -> 1 if D has a key k, else 0"; + +static char get__doc__[] = +"D.get(k[,d]) -> D[k] if D.has_key(k), else d. d defaults to None."; + +static char setdefault_doc__[] = +"D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if not D.has_key(k)"; + +static char popitem__doc__[] = +"D.popitem() -> (k, v), remove and return some (key, value) pair as a\n\ +2-tuple; but raise KeyError if D is empty"; + +static char keys__doc__[] = +"D.keys() -> list of D's keys"; + +static char items__doc__[] = +"D.items() -> list of D's (key, value) pairs, as 2-tuples"; + +static char values__doc__[] = +"D.values() -> list of D's values"; + +static char update__doc__[] = +"D.update(E) -> None. Update D from E: for k in E.keys(): D[k] = E[k]"; + +static char clear__doc__[] = +"D.clear() -> None. Remove all items from D."; + +static char copy__doc__[] = +"D.copy() -> a shallow copy of D"; + static PyMethodDef mapp_methods[] = { - {"has_key", (PyCFunction)dict_has_key, METH_VARARGS}, - {"keys", (PyCFunction)dict_keys}, - {"items", (PyCFunction)dict_items}, - {"values", (PyCFunction)dict_values}, - {"update", (PyCFunction)dict_update}, - {"clear", (PyCFunction)dict_clear}, - {"copy", (PyCFunction)dict_copy}, - {"get", (PyCFunction)dict_get, METH_VARARGS}, - {"setdefault", (PyCFunction)dict_setdefault, METH_VARARGS}, - {"popitem", (PyCFunction)dict_popitem}, - {NULL, NULL} /* sentinel */ + {"has_key", (PyCFunction)dict_has_key, METH_VARARGS, + has_key__doc__}, + {"get", (PyCFunction)dict_get, METH_VARARGS, + get__doc__}, + {"setdefault", (PyCFunction)dict_setdefault, METH_VARARGS, + setdefault_doc__}, + {"popitem", (PyCFunction)dict_popitem, METH_OLDARGS, + popitem__doc__}, + {"keys", (PyCFunction)dict_keys, METH_OLDARGS, + keys__doc__}, + {"items", (PyCFunction)dict_items, METH_OLDARGS, + items__doc__}, + {"values", (PyCFunction)dict_values, METH_OLDARGS, + values__doc__}, + {"update", (PyCFunction)dict_update, METH_OLDARGS, + update__doc__}, + {"clear", (PyCFunction)dict_clear, METH_OLDARGS, + clear__doc__}, + {"copy", (PyCFunction)dict_copy, METH_OLDARGS, + copy__doc__}, + {NULL, NULL} /* sentinel */ }; static PyObject * |