From a6ce616a5be113697a7181bf8cb58b0a2c6b6f6b Mon Sep 17 00:00:00 2001 From: Michael Wagner Date: Thu, 6 Feb 2025 21:54:34 +0000 Subject: [PATCH] Improve docstring --- glue/flagging_script_glue/flagging.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/glue/flagging_script_glue/flagging.py b/glue/flagging_script_glue/flagging.py index 9f4be2f..1530130 100644 --- 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}"]