summaryrefslogtreecommitdiff
path: root/docs/password_hash_api.rst
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-06-29 13:57:35 -0400
committerEli Collins <elic@assurancetechnologies.com>2011-06-29 13:57:35 -0400
commit62991573b68a5db0815db0f48532ef967380422e (patch)
treef2801320703c9de2d1bcffc37f8eeb2af086da4e /docs/password_hash_api.rst
parent83440e9240061d538c2daed6ec9e38171be66e4f (diff)
downloadpasslib-62991573b68a5db0815db0f48532ef967380422e.tar.gz
updated changelog to include python 3 compat; various other documentation updates
Diffstat (limited to 'docs/password_hash_api.rst')
-rw-r--r--docs/password_hash_api.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/password_hash_api.rst b/docs/password_hash_api.rst
index 951d69d..fe3b499 100644
--- a/docs/password_hash_api.rst
+++ b/docs/password_hash_api.rst
@@ -235,7 +235,7 @@ which scheme a hash belongs to when multiple schemes are in use.
In order to accomplish this, many implementations perform only minimal
validation of the candidate hashes. Thus, they may return ``True``
for hashes which are identifiable, but malformed enough that
- a :exc:`ValueError` when the string is passed to
+ a :exc:`ValueError` is raised when the string is passed to
:func:`~PasswordHash.verify` or :func:`~PasswordHash.genhash`.
Because of this, applications should rely on this method only for identification,
not confirmation that a hash is correctly formed.
@@ -482,13 +482,15 @@ the following attributes are usually exposed.
xxx: what about a bits_per_salt_char or some such, so effective salt strength
can be compared?
+.. _hash-unicode-behavior:
+
Unicode Behavior
================
-.. versionadded:: Passlib 1.5
+.. versionadded:: 1.5
Quick summary
-------------
+-------------
For the application developer in a hurry:
* Passwords should be provided as :class:`unicode` if possible.