Fixes #237

UMEP-dev · Nov 21, 2023 · 595f168 · 595f168
1 parent 55e9ea5
commit 595f168
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/supy/supy/_check.py b/src/supy/supy/_check.py
@@ -296,6 +296,16 @@ def flatten_col(df_state: pd.DataFrame):
 
 # upgrade df_state from earlier versions of SuPy
 def upgrade_df_state(df_state: pd.DataFrame) -> pd.DataFrame:
+    """
+    Upgrades the input DataFrame `df_state` if it contains deprecated columns.
+    If the DataFrame is already up to date, it returns a copy of the input DataFrame.
+
+    Parameters:
+    - df_state (pd.DataFrame): The DataFrame to be upgraded.
+
+    Returns:
+    - pd.DataFrame: The upgraded DataFrame if it contains deprecated columns, otherwise a copy of the input DataFrame.
+    """
     df_state_deprecated = df_state.copy()
     df_state_deprecated.columns = df_state_deprecated.columns.remove_unused_levels()