Skip to content

Commit d4764e6

Browse files
committed
fix: update user guide links in DataFrame class documentation for clarity
1 parent 2f4d41b commit d4764e6

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

examples/example_fail.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
from typing import TYPE_CHECKING, TypeGuard
2+
3+
if TYPE_CHECKING:
4+
from _typeshed import CapsuleType as _PyCapsule
5+
6+
def is_capsule(obj: object) -> TypeGuard[_PyCapsule]:
7+
return hasattr(obj, "__capsule__")
8+
9+
print("This will break soon...")

python/datafusion/dataframe.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1320,9 +1320,10 @@ def __arrow_c_stream__(self, requested_schema: object | None = None) -> object:
13201320
Arrow ``PyCapsule`` object representing an ``ArrowArrayStream``.
13211321
13221322
For practical usage patterns, see the Apache Arrow streaming
1323-
documentation: https://arrow.apache.org/docs/python/ipc.html#streaming
1324-
and the DataFusion user guide sections on Arrow I/O and DataFrame
1325-
streaming (:doc:`../io/arrow` and :doc:`../dataframe/index`).
1323+
documentation: https://arrow.apache.org/docs/python/ipc.html#streaming.
1324+
1325+
For details on DataFusion's Arrow integration and DataFrame streaming,
1326+
see the user guide (user-guide/io/arrow and user-guide/dataframe/index).
13261327
13271328
Notes:
13281329
The Arrow C Data Interface PyCapsule details are documented by Apache

0 commit comments

Comments
 (0)