Skip to content

Commit f5b5e95

Browse files
DOCS: Add 'See Also'and return value description for pandas.api.interchange.from_dataframe
1 parent 224c6ff commit f5b5e95

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

ci/code_checks.sh

+2-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
207207
-i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
208208
-i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \
209209
-i "pandas.api.extensions.ExtensionArray.view SA01" \
210-
-i "pandas.api.interchange.from_dataframe RT03,SA01" \
210+
-i "pandas.api.indexers.VariableOffsetWindowIndexer PR01,SA01" \
211+
-i "pandas.api.types.is_any_real_numeric_dtype SA01" \
211212
-i "pandas.api.types.is_bool PR01,SA01" \
212213
-i "pandas.api.types.is_categorical_dtype SA01" \
213214
-i "pandas.api.types.is_complex PR01,SA01" \

pandas/core/interchange/from_dataframe.py

+7
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@ def from_dataframe(df, allow_copy: bool = True) -> pd.DataFrame:
6060
Returns
6161
-------
6262
pd.DataFrame
63+
A pandas DataFrame built from the provided interchange
64+
protocol object.
65+
66+
See Also
67+
--------
68+
_from_dataframe : Internal function to build a pandas DataFrame from
69+
a DataFrameXchg.
6370
6471
Examples
6572
--------

0 commit comments

Comments
 (0)