summaryrefslogtreecommitdiff
path: root/python/indexrecords.cc
diff options
context:
space:
mode:
Diffstat (limited to 'python/indexrecords.cc')
-rw-r--r--python/indexrecords.cc16
1 files changed, 10 insertions, 6 deletions
diff --git a/python/indexrecords.cc b/python/indexrecords.cc
index ac4a7c2e..c5ebcfbc 100644
--- a/python/indexrecords.cc
+++ b/python/indexrecords.cc
@@ -44,9 +44,11 @@ static PyObject *indexrecords_load(PyObject *self,PyObject *args)
return HandleErrors(PyBool_FromLong(records->Load(filename)));
}
-static char *indexrecords_lookup_doc = "lookup(metakey)\n\n"
- "Lookup the filename given by metakey, return a tuple (hash, size).\n"
- "The hash part is a HashString() object.";
+static char *indexrecords_lookup_doc =
+ "lookup(key: str) -> (HashString, int)\n\n"
+ "Lookup the filename given by 'key', return a tuple (hash, size),\n"
+ "whereas the first element 'hash' is an apt_pkg.HashString object\n"
+ "and the second element 'size' an int object.";
static PyObject *indexrecords_lookup(PyObject *self,PyObject *args)
{
const char *keyname;
@@ -74,15 +76,17 @@ static PyObject *indexrecords_get_dist(PyObject *self)
static PyMethodDef indexrecords_methods[] = {
{"load",indexrecords_load,METH_VARARGS,
- "load(filename: str)\n\nLoad the file given by filename."},
+ "load(filename: str)\n\n"
+ "Load the file given by filename."},
{"get_dist",(PyCFunction)indexrecords_get_dist,METH_NOARGS,
- "get_dist() -> str\n\nReturn a distribution set in the release file."},
+ "get_dist() -> str\n\n"
+ "Return a distribution set in the release file."},
{"lookup",indexrecords_lookup,METH_VARARGS,indexrecords_lookup_doc},
{}
};
static char *indexrecords_doc = "IndexRecords()\n\n"
- "Representation of a release file.";
+ "Representation of a Release file.";
PyTypeObject PyIndexRecords_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
"apt_pkg.IndexRecords", // tp_name