summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-07-13 14:37:31 -0400
committerEli Collins <elic@assurancetechnologies.com>2011-07-13 14:37:31 -0400
commit151afc5d6a057f0eac75badfcd0eb808258fa1ea (patch)
treefc36050eb7c54ec987e5b379546f94b7de9750a7
parent8ad26e0b17a8ce25fe40abfa6740fc297cdd6d5b (diff)
downloadpasslib-151afc5d6a057f0eac75badfcd0eb808258fa1ea.tar.gz
minor doc changes
-rw-r--r--docs/conf.py4
-rw-r--r--passlib/handlers/bcrypt.py5
-rw-r--r--passlib/utils/__init__.py6
3 files changed, 11 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 29239be..a412f3e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -30,6 +30,10 @@ sys.path.insert(0, source_root)
#which contains some sphinx extensions used by passlib
import cloud_sptheme
+#hack to make autodoc generate documentation from the correct class...
+from passlib.utils import md4
+md4.md4 = md4._builtin_md4
+
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
diff --git a/passlib/handlers/bcrypt.py b/passlib/handlers/bcrypt.py
index 44192f6..3b3d68f 100644
--- a/passlib/handlers/bcrypt.py
+++ b/passlib/handlers/bcrypt.py
@@ -62,7 +62,10 @@ class bcrypt(uh.HasManyIdents, uh.HasRounds, uh.HasSalt, uh.HasManyBackends, uh.
* `py-bcrypt <http://www.mindrot.org/projects/py-bcrypt/>`_, if installed.
* `bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_, if installed.
- * stdlib :func:`crypt()`, if the host OS supports BCrypt (eg BSD).
+ * stdlib :func:`crypt()`, if the host OS supports BCrypt (eg: BSD).
+ * if no backends are available at runtime,
+ :exc:`~passlib.utils.MissingBackendError` will be raised
+ whenever :meth:`encrypt` or :meth:`verify` are called.
You can see which backend is in use by calling the :meth:`get_backend()` method.
"""
diff --git a/passlib/utils/__init__.py b/passlib/utils/__init__.py
index ac82055..d2c4d8c 100644
--- a/passlib/utils/__init__.py
+++ b/passlib/utils/__init__.py
@@ -113,8 +113,8 @@ Undef = UndefType()
NoneType = type(None)
class MissingBackendError(RuntimeError):
- """error raised if multi-backend handler has no backends;
- or specific backend not available.
+ """error raised if multi-backend handler has no available backends;
+ or if specifically requested backend is not available.
see :class:`~passlib.utils.handlers.HasManyBackends`.
"""
@@ -280,7 +280,7 @@ def is_crypt_handler(obj):
))
def is_crypt_context(obj):
- "check if object follows :class:`CryptContext` interface"
+ "check if object appears to be a :class:`~passlib.context.CryptContext` instance"
return all(hasattr(obj, name) for name in (
"hash_needs_update",
"genconfig", "genhash",