Skip to content

Commit 694c8de

Browse files
committed
doc: update from_dataframe docstring for clarity on DataFrame types and conversion
1 parent 5300398 commit 694c8de

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

python/datafusion/table_provider.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,12 @@ def from_dataframe(cls, df: Any) -> TableProvider:
5858
Parameters
5959
----------
6060
df:
61-
Either a :class:`~datafusion.dataframe.DataFrame` instance or a
62-
DataFrame convertible via the Arrow FFI (for example,
63-
:class:`pandas.DataFrame` or :class:`polars.DataFrame`). When you
64-
already have a DataFusion DataFrame prefer calling
65-
:meth:`~datafusion.dataframe.DataFrame.into_view` directly.
61+
Either a :class:`~datafusion.dataframe.DataFrame` wrapper or the
62+
corresponding :class:`~datafusion._internal.DataFrame`. When
63+
working with third-party DataFrame libraries, convert them via
64+
:meth:`~datafusion.SessionContext.from_arrow` before calling
65+
:meth:`~datafusion.dataframe.DataFrame.into_view` or this
66+
constructor.
6667
"""
6768
from datafusion.dataframe import DataFrame as DataFrameWrapper
6869

0 commit comments

Comments
 (0)