Skip to content

Commit a93b4be

Browse files
committed
Fix DataFrame.__dataframe__ docstring more
Signed-off-by: Vasily Litvinov <[email protected]>
1 parent fc0f610 commit a93b4be

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

pandas/core/frame.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -819,10 +819,27 @@ def __dataframe__(
819819
"""
820820
Return the dataframe exchange object implementing the exchange protocol.
821821
822+
Parameters
823+
----------
824+
nan_as_null : bool, default False
825+
Whether to tell the DataFrame to overwrite null values in the data
826+
with ``NaN`` (or ``NaT``).
827+
allow_copy : bool, default True
828+
Whether to allow memory copying when exporting. If set to False
829+
it would cause non-zero-copy exports to fail.
830+
831+
Returns
832+
-------
833+
DataFrame exchange object
834+
The object which consuming library can use to ingress the dataframe.
835+
822836
Notes
823837
-----
824838
Details on the exchange protocol:
825839
https://data-apis.org/dataframe-protocol/latest/index.html
840+
841+
`nan_as_null` currently has no effect; once support for nullable extension
842+
dtypes is added, this value should be propagated to columns.
826843
"""
827844

828845
from pandas.core.exchange.dataframe import PandasDataFrameXchg

0 commit comments

Comments
 (0)