summaryrefslogtreecommitdiff
path: root/alot/helper.py
diff options
context:
space:
mode:
authorLucas Hoffmann <l-m-h@web.de>2017-06-12 16:02:28 +0200
committerLucas Hoffmann <l-m-h@web.de>2017-06-21 09:17:55 +0200
commite5d948894865601f74f3075f688240174988321e (patch)
treef0d02aaa043d24f224fa0c4aec5a6dd6c17c754d /alot/helper.py
parentd8c764f5b32bb104dc9b0a517a81e4845dc07bed (diff)
Extend docstring
Diffstat (limited to 'alot/helper.py')
-rw-r--r--alot/helper.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/alot/helper.py b/alot/helper.py
index f673781e..b73ee7b1 100644
--- a/alot/helper.py
+++ b/alot/helper.py
@@ -104,6 +104,14 @@ def string_sanitize(string, tab_width=8):
def string_decode(string, enc='ascii'):
"""
safely decodes string to unicode bytestring, respecting `enc` as a hint.
+
+ :param string: the string to decode
+ :type string: str or unicode
+ :param enc: a hint what encoding is used in string ('ascii', 'utf-8', ...)
+ :type enc: str
+ :returns: the unicode decoded input string
+ :rtype: unicode
+
"""
if enc is None: