docs: added type hints to outstanding functions and docstrings

src/input_handling.py

@@ -27,7 +27,16 @@ allowed_image_types = ['jpg', 'jpeg', 'png', 'webp']
 
 import random
 import string
-def generate_random_md5():
+def generate_random_md5() -> str:
+    """
+    Generates a random MD5 hash.
+
+    This function creates a random string of 16 alphanumeric characters,
+    encodes it, and then computes its MD5 hash.
+
+    Returns:
+        str: The MD5 hash of the generated random string.
+    """
     # Generate a random string
     random_string = ''.join(random.choices(string.ascii_letters + string.digits, k=16))
     # Encode the string and compute its MD5 hash

src/whale_viewer.py

@@ -1,4 +1,5 @@
 from typing import List
+from streamlit.delta_generator import DeltaGenerator
 
 from PIL import Image
 import pandas as pd
@@ -117,22 +118,20 @@ def format_whale_name(whale_class:str) -> str:
     return whale_name
 
 
-def display_whale(whale_classes:List[str], i:int, viewcontainer=None):
+def display_whale(whale_classes:List[str], i:int, viewcontainer:DeltaGenerator=None) -> None:
     """
     Display whale image and reference to the provided viewcontainer.
 
     Args:
         whale_classes (List[str]): A list of whale class names.
         i (int): The index of the whale class to display.
-        viewcontainer: The container to display the whale information. If 
-            not provided, use the current streamlit context (works via 
-            'with `container`' syntax)
+        viewcontainer (streamlit.delta_generator.DeltaGenerator): The container
+            to display the whale information. If not provided, use the current
+            streamlit context (works via 'with `container`' syntax)
 
     Returns:
         None
     
-    TODO: how to find the object type of viewcontainer.? they are just "deltagenerators" but 
-    we want the result of the generator.. In any case, it works ok with either call signature.
     """
     import streamlit as st
     if viewcontainer is None: