some formatting and more docstrings

comcrawl/utils/download.py

@@ -25,7 +25,6 @@ def download_single_result(result: Result) -> Result:
         The provided result, extendey by the corresponding HTML String.
 
     """
-
     offset, length = int(result["offset"]), int(result["length"])
 
     offset_end = offset + length - 1
@@ -68,7 +67,6 @@ def download_multiple_results(results: ResultList,
         HTML strings.
 
     """
-
     results_with_html = []
 
     # multi-threaded download

comcrawl/utils/initialization.py

@@ -16,7 +16,6 @@ def fetch_available_indexes() -> IndexList:
         A list containing available indexes and information about them.
 
     """
-
     index_list = (requests
                   .get("https://index.commoncrawl.org/collinfo.json")
                   .json())

comcrawl/utils/multithreading.py

@@ -11,8 +11,34 @@
 
 def make_multithreaded(func: Callable,
                        threads: int) -> Callable:
+    """Creates a multithreaded version of a function
+
+    Args:
+        func: Function that is meant to be executed on
+            a list of input objects.
+        threads: The number of threads the multithreaded
+            version of the function should use.
+
+    Returns:
+        A multithreaded version of the `func` input function.
+
+    """
 
     def multithreaded_function(input_list: List, *args) -> List:
+        """Executes function on input list using multiple threads
+
+        Args:
+            input_list: The list of objects a function should be
+                executed on.
+            *args: Variable length argument list of additional
+                parameters needed for the function to be executed.
+
+        Returns:
+            List of results after all input list elements were 
+            processed. Input order might not be preserved in 
+            output list.
+
+        """
         results = []
 
         with futures.ThreadPoolExecutor(max_workers=threads) as executor:

comcrawl/utils/search.py

@@ -25,7 +25,6 @@ def search_single_index(index: str, url: str) -> ResultList:
         List of results dictionaries found in specified Index for the URL.
 
     """
-
     results: ResultList = []
 
     url = URL_TEMPLATE.format(index=index, url=url)
@@ -55,7 +54,6 @@ def search_multiple_indexes(url: str,
         Common Crawl indexes.
 
     """
-
     results = []
 
     # multi-threaded search