Added docstring to webauskunft_from_str.
authorphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Sun, 29 Jan 2017 22:18:59 +0000 (22:18 +0000)
committerphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Sun, 29 Jan 2017 22:18:59 +0000 (22:18 +0000)
git-svn-id: http://www.winterrodeln.org/svn/wrpylib/trunk@2627 7aebc617-e5e2-0310-91dc-80fb5f6d2477

wrpylib/wrvalidators.py

index 91e902b467274a20d57ad87b55a69767505d721a..c827d5e48f5a2400f92e1133158518b95232eec3 100644 (file)
@@ -335,6 +335,14 @@ def url_to_str(value):
 # ---------------------
 
 def webauskunft_from_str(value):
 # ---------------------
 
 def webauskunft_from_str(value):
+    """Converts a URL or 'Nein' to a tuple
+    'http://www.example.com/' -> (True, 'http://www.example.com/')
+    'Nein' -> (False, None)
+    '' -> (None, None)
+
+    :param value: URL or 'Nein'
+    :return: tuple
+    """
     return opt_no_german_from_str(value, url_from_str)
 
 
     return opt_no_german_from_str(value, url_from_str)