adds docstrings

app/analysis/plotly_heat_user-activity.py

@@ -10,13 +10,30 @@ from app.logging_config import get_logger
 logger = get_logger()
 
 class PlotlyActivityHeatmap(BasePlotlyAnalysis):
+    """
+    Class for analyzing user activity trends over multiple days and generating an interactive heatmap.
+
+    Attributes:
+    name (str): The name of the analysis.
+    description (str): A brief description of the analysis.
+    plot_filename (str): The filename for the output plot.
+    note (str): Additional notes for the analysis.
+    """
     name = "Activity Heatmap (Interactive)"
     description = "Displays user activity trends over multiple days using an interactive heatmap."
     plot_filename = "activity_heatmap.html"
     note = ""
     
     def transform_data(self, df: pd.DataFrame) -> pd.DataFrame:
-        """Transform data for the heatmap"""
+        """
+        Transform data for the heatmap.
+
+        Parameters:
+        df (pd.DataFrame): The input DataFrame containing user activity data.
+
+        Returns:
+        pd.DataFrame: The transformed DataFrame with activity counts by hour.
+        """
         df['hour'] = df['timestamp'].dt.hour
         active_counts = df[df['was_active']].pivot_table(
             index='name', 
@@ -34,7 +51,12 @@ class PlotlyActivityHeatmap(BasePlotlyAnalysis):
         return active_counts
 
     def plot_data(self, df: pd.DataFrame):
-        """Generate heatmap plot"""
+        """
+        Generate heatmap plot.
+
+        Parameters:
+        df (pd.DataFrame): The transformed DataFrame containing activity counts by hour.
+        """
         df = df.pivot(index='name', columns='hour', values='activity_count').fillna(0)
 
         # Create a Plotly heatmap