From f32a08ecb482f97a06ee944af183f032c7dfee38 Mon Sep 17 00:00:00 2001 From: Eli Collins Date: Sun, 27 Nov 2016 12:51:31 -0500 Subject: docs: fixed docstring for utils.saslprep() --- passlib/utils/__init__.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'passlib') 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 -- cgit v1.2.1