Improve docstring

ccao-data · Feb 6, 2025 · a6ce616 · a6ce616
1 parent c08872d
commit a6ce616
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/glue/flagging_script_glue/flagging.py b/glue/flagging_script_glue/flagging.py
@@ -254,6 +254,10 @@ def which_price(row: pd.Series, groups: tuple) -> str:
     """
     Determines which price measure (raw, per sqft, or both) is flagged as an outlier
     by comparing deviation values with per-row thresholds.
+    Inputs:
+        groups (tuple): tuple of columns used for statistical grouping
+    Outputs:
+        value (str): string saying which of these are outliers.
     """
     group_str = create_group_string(groups, "_")
     raw_val = row[f"sv_price_deviation_{group_str}"]