Add docstrings for functions in download_apple.py and task_datamanagement_apple.py.

Author: Lenr4

src/lennart_epp/data_management/download_apple.py

@@ -6,9 +6,19 @@
 
 
 def download_apple_data():
+    """Download and save historical Apple stock data.
+
+    Args:
+        None
+
+    Returns:
+        None
+
+    Raises:
+        Exception: If the download fails due to network issues or API errors.
+    """
     raw_data_path = SRC / "data" / "apple_data.csv"
 
-    # ✅ Nur herunterladen, wenn die Datei noch nicht existiert
     if not raw_data_path.exists():
         Path(raw_data_path.parent).mkdir(parents=True, exist_ok=True)
         apple_data = yf.download("AAPL", start="2013-01-01", end="2023-12-31")

src/lennart_epp/data_management/task_datamanagement_apple.py

@@ -1,5 +1,3 @@
-"""Tasks for managing the stock data."""
-
 import pandas as pd
 
 from lennart_epp.config import BLD, SRC
@@ -11,7 +9,18 @@ def task_download_apple_data(
     script=SRC / "data_management" / "download_apple.py",
     produces=SRC / "data" / "apple_data.csv",
 ):
-    """Download AAPL stock data."""
+    """Download and save historical Apple stock data.
+
+    Args:
+        script (Path, optional): Path to the script handling the download.
+        produces (Path, optional): Path where the downloaded CSV file is stored.
+
+    Returns:
+        None
+
+    Raises:
+        AssertionError: If the file was not successfully created.
+    """
     download_apple_data()
     assert produces.exists(), f"Failed to produce {produces}"
 
@@ -21,7 +30,19 @@ def task_clean_apple_data(
     data=SRC / "data" / "apple_data.csv",
     produces=BLD / "data" / "cleaned_apple_data.pkl",
 ):
-    """Clean the stock data."""
+    """Load, clean, and store Apple stock data.
+
+    Args:
+        script (Path, optional): Path to the script handling data cleaning.
+        data (Path, optional): Path to the raw stock data CSV file.
+        produces (Path, optional): Path where the cleaned data is stored.
+
+    Returns:
+        None
+
+    Raises:
+        AssertionError: If the cleaned data file was not successfully created.
+    """
     df = pd.read_csv(data, skiprows=2)
     df.columns = ["Date", "Close", "High", "Low", "Open", "Volume"]
     df = clean_apple_data(df)