docs: add to docstrings in check_data

invia-flights · Jan 4, 2023 · c68f0b0 · c68f0b0
1 parent 8994b28
commit c68f0b0
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/blitzly/etc/utils.py b/src/blitzly/etc/utils.py
@@ -109,6 +109,10 @@ def check_data(
         max_rows (Optional[int]): The maximum number of rows the data must have.
         min_columns (Optional[int]): The minimum number of columns the data must have.
         max_columns (Optional[int]): The maximum number of columns the data must have.
+        as_pandas (bool): Whether to keep data as or convert data to pd.DataFrame
+
+    Returns:
+        Union[pd.DataFrame, NDArray]: The data that passes all checks, and is converted to the required dtype.
 
     Raises:
         TypeError: If the data is not a DataFrame, numpy array, or list of values.