DOCS: Add 'See Also'and return value description for pandas.api.inter…

…change.from_dataframe
pandas-dev · Aug 24, 2024 · f5b5e95 · f5b5e95
1 parent 224c6ff
commit f5b5e95
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -207,7 +207,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
         -i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \
         -i "pandas.api.extensions.ExtensionArray.view SA01" \
-        -i "pandas.api.interchange.from_dataframe RT03,SA01" \
+        -i "pandas.api.indexers.VariableOffsetWindowIndexer PR01,SA01" \
+        -i "pandas.api.types.is_any_real_numeric_dtype SA01" \
         -i "pandas.api.types.is_bool PR01,SA01" \
         -i "pandas.api.types.is_categorical_dtype SA01" \
         -i "pandas.api.types.is_complex PR01,SA01" \

diff --git a/pandas/core/interchange/from_dataframe.py b/pandas/core/interchange/from_dataframe.py
@@ -60,6 +60,13 @@ def from_dataframe(df, allow_copy: bool = True) -> pd.DataFrame:
     Returns
     -------
     pd.DataFrame
+        A pandas DataFrame built from the provided interchange
+        protocol object.
+
+    See Also
+    --------
+    _from_dataframe : Internal function to build a pandas DataFrame from
+        a DataFrameXchg.
 
     Examples
     --------