Added doctstring

Author: gisatb

examples/intro.ipynb

@@ -58,7 +58,9 @@
    "id": "cc74a4a3",
    "metadata": {},
    "outputs": [],
-   "source": []
+   "source": [
+    "mapvu.generate_lucky_number()"
+   ]
   }
  ],
  "metadata": {

mapvu/mapvu.py

@@ -4,6 +4,17 @@
 import random
 
 def generate_random_string(length=10, upper=False, digits=False, punctuation=False ):
+    """Generate a random string of given length
+
+    Args:
+        length (int, optional): The length of the string to generate. Defaults to 10.
+        upper (bool, optional): Whether to include uppercase letters. Defaults to False.
+        digits (bool, optional): Whether to include lowercase letters. Defaults to False.
+        punctuation (bool, optional): Whether to include pounctuation. Defaults to False.
+
+    Returns:
+        _type_: The genearted string
+    """    
     letters = string.ascii_lowercase
     if upper:
         letters += string.ascii_uppercase
@@ -16,5 +27,13 @@ def generate_random_string(length=10, upper=False, digits=False, punctuation=Fal
 
 
 def generate_lucky_number(length=1):
+    """Generate a random number of given length
+
+    Args:
+        length (int, optional): The length of the number to generate. Defaults to 1.
+
+    Returns:
+        _type_: the generated numbers
+    """    
     result_str = '' .join(random.choice(string.digits) for i in range(length))
     return int(result_str)