Skip to content

Commit a70e3d6

Browse files
committed
doc: enhance from_dataframe docstring with detailed parameter information
1 parent f35ed04 commit a70e3d6

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

python/datafusion/table_provider.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,17 @@ def from_capsule(cls, capsule: Any) -> TableProvider:
5353

5454
@classmethod
5555
def from_dataframe(cls, df: Any) -> TableProvider:
56-
"""Create a :class:`TableProvider` from a :class:`DataFrame`."""
56+
"""Create a :class:`TableProvider` from tabular data.
57+
58+
Parameters
59+
----------
60+
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.
66+
"""
5767
from datafusion.dataframe import DataFrame as DataFrameWrapper
5868

5969
if isinstance(df, DataFrameWrapper):

0 commit comments

Comments
 (0)