summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2016-11-27 12:51:31 -0500
committerEli Collins <elic@assurancetechnologies.com>2016-11-27 12:51:31 -0500
commitf32a08ecb482f97a06ee944af183f032c7dfee38 (patch)
tree6221997d63a682bedf1bfaf6f01e5222931150e1
parent8ee063dd5f436fdd035e6f596b82ba61bde079a6 (diff)
downloadpasslib-f32a08ecb482f97a06ee944af183f032c7dfee38.tar.gz
docs: fixed docstring for utils.saslprep()
-rw-r--r--passlib/utils/__init__.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/passlib/utils/__init__.py b/passlib/utils/__init__.py
index e5cc476..fcc9686 100644
--- a/passlib/utils/__init__.py
+++ b/passlib/utils/__init__.py
@@ -402,13 +402,16 @@ def saslprep(source, param="value"):
unicode string to normalize & validate
:param param:
- Optional noun used to refer to identify source parameter in error messages
+ Optional noun identifying source parameter in error messages
(Defaults to the string ``"value"``). This is mainly useful to make the caller's error
- messages make more sense.
+ messages make more sense contextually.
:raises ValueError:
if any characters forbidden by the SASLPrep profile are encountered.
+ :raises TypeError:
+ if input is not :class:`!unicode`
+
:returns:
normalized unicode string