fix: fixed/addressed the correlation plot docstring

UBC-MDS · Feb 4, 2025 · f1d044e · f1d044e
1 parent 762bb5c
commit f1d044e
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/summarease/summarize_numeric.py b/src/summarease/summarize_numeric.py
@@ -64,10 +64,10 @@ def plot_correlation_heatmap(dataset_numeric: pd.DataFrame):
     save_path : str, optional
         File path to save the generated heatmap. If None, the plot will not be saved.
 
-    Returns:
+    Returns
     -------
-    None
-        Displays the correlation heatmap or optionally saves it to the specified location.
+    alt.Chart
+        The Altair chart visualizing the correlation heatmap.
 
     Example:
     -------