summaryrefslogtreecommitdiffstats
path: root/Modules/cryptmodule.c
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-02-01 20:12:39 (GMT)
committerFred Drake <fdrake@acm.org>2000-02-01 20:12:39 (GMT)
commita664dbbff8ad22d0eb4ec48461d3d9a50c5fb693 (patch)
treece28d4e56968a6a33678942be6c8e1c1c3200cd5 /Modules/cryptmodule.c
parentb3d3956e019196b28b6c25b2ec195a8815047be8 (diff)
downloadcpython-a664dbbff8ad22d0eb4ec48461d3d9a50c5fb693.zip
cpython-a664dbbff8ad22d0eb4ec48461d3d9a50c5fb693.tar.gz
cpython-a664dbbff8ad22d0eb4ec48461d3d9a50c5fb693.tar.bz2
Added docstring to crypt.crypt() based on the documentation.
Diffstat (limited to 'Modules/cryptmodule.c')
-rw-r--r--Modules/cryptmodule.c11
1 files changed, 10 insertions, 1 deletions
diff --git a/Modules/cryptmodule.c b/Modules/cryptmodule.c
index 7cc03be..746dee1 100644
--- a/Modules/cryptmodule.c
+++ b/Modules/cryptmodule.c
@@ -22,8 +22,17 @@ static PyObject *crypt_crypt(self, args)
}
+static char crypt_crypt__doc__[] = "\
+crypt(word, salt) -> string\n\
+word will usually be a user's password. salt is a 2-character string\n\
+which will be used to select one of 4096 variations of DES. The characters\n\
+in salt must be either \".\", \"/\", or an alphanumeric character. Returns\n\
+the hashed password as a string, which will be composed of characters from\n\
+the same alphabet as the salt.";
+
+
static PyMethodDef crypt_methods[] = {
- {"crypt", crypt_crypt},
+ {"crypt", crypt_crypt, 0, crypt_crypt__doc__},
{NULL, NULL} /* sentinel */
};