Skip to content

Commit 78f6c8a

Browse files
committed
Add documentation note for Arrow C Data Interface PyCapsule in DataFrame class
1 parent 9baa49e commit 78f6c8a

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

python/datafusion/dataframe.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1135,6 +1135,11 @@ def __arrow_c_stream__(self, requested_schema: object | None = None) -> object:
11351135
>>> stream = df.__arrow_c_stream__(schema)
11361136
>>> capsule = schema._export_to_c_capsule()
11371137
>>> stream = df.__arrow_c_stream__(capsule)
1138+
1139+
Notes:
1140+
The Arrow C Data Interface PyCapsule details are documented by Apache
1141+
Arrow and can be found at:
1142+
https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html
11381143
"""
11391144
# ``DataFrame.__arrow_c_stream__`` in the Rust extension leverages
11401145
# ``execute_stream_partitioned`` under the hood to stream batches while

0 commit comments

Comments
 (0)