- first cut at adding doc strings

This commit is contained in:
Nalin Dahyabhai 2007-01-29 22:30:35 +00:00
parent b64d92cc00
commit f8e88bbbd5

View File

@ -0,0 +1,38 @@
Some docstrings for the Python module. Need to figure out how to fix the
summary in the help() output.
diff -ur cracklib-2.8.9/python/cracklibmodule.c cracklib-2.8.9/python/cracklibmodule.c
--- cracklib-2.8.9/python/cracklibmodule.c 2007-01-29 17:28:41.000000000 -0500
+++ cracklib-2.8.9/python/cracklibmodule.c 2007-01-29 17:20:14.000000000 -0500
@@ -24,7 +24,6 @@
static PyObject *
cracklib_FascistCheck(PyObject *self, PyObject *args, PyObject *kwargs)
{
- int i;
char *candidate, *dict;
const char *result;
struct stat st;
@@ -96,12 +95,21 @@
static PyMethodDef
cracklibmethods[] =
{
- {"FascistCheck", cracklib_FascistCheck, METH_VARARGS | METH_KEYWORDS},
+ {"FascistCheck", cracklib_FascistCheck, METH_VARARGS | METH_KEYWORDS,
+ "Keyword arguments:\n"
+ " pw - candidate password\n"
+ " dict - dictionary location (default \""
+ DEFAULT_CRACKLIB_DICT
+ "\")\n"
+ "\n"
+ "Returns:\n"
+ " None on success, an error string on failure.\n"},
{NULL, NULL},
};
void
initcracklib(void)
{
- Py_InitModule("cracklib", cracklibmethods);
+ Py_InitModule3("cracklib", cracklibmethods,
+ "Python interface to libcrack's FascistCheck() function.\n");
}