Skip to content

Commit 56e42a0

Browse files
committed
Replaced the DataFrame.__arrow_c_stream__ docstring example with a link to the Apache Arrow streaming documentation for practical guidance.
1 parent 08312bb commit 56e42a0

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

python/datafusion/dataframe.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1319,11 +1319,9 @@ def __arrow_c_stream__(self, requested_schema: object | None = None) -> object:
13191319
Returns:
13201320
Arrow ``PyCapsule`` object representing an ``ArrowArrayStream``.
13211321
1322-
Examples:
1323-
>>> schema = df.schema()
1324-
>>> stream = df.__arrow_c_stream__(schema)
1325-
>>> capsule = schema._export_to_c_capsule()
1326-
>>> stream = df.__arrow_c_stream__(capsule)
1322+
For practical usage patterns, refer to the Apache Arrow streaming
1323+
documentation:
1324+
https://arrow.apache.org/docs/python/ipc.html#streaming
13271325
13281326
Notes:
13291327
The Arrow C Data Interface PyCapsule details are documented by Apache

0 commit comments

Comments
 (0)