File tree 1 file changed +6
-4
lines changed
1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -397,14 +397,16 @@ def __dataframe__(
397
397
"""
398
398
Construct a new exchange object, potentially changing the parameters.
399
399
400
- ``nan_as_null`` is a keyword intended for the consumer to tell the
401
- producer to overwrite null values in the data with ``NaN``.
402
- It is intended for cases where the consumer does not support the bit
403
- mask or byte mask that is the producer's native representation.
400
+ ``nan_as_null`` is a DEPRECATED keyword that should not be used. See warning
401
+ below.
404
402
``allow_copy`` is a keyword that defines whether or not the library is
405
403
allowed to make a copy of the data. For example, copying data would be
406
404
necessary if a library supports strided buffers, given that this protocol
407
405
specifies contiguous buffers.
406
+
407
+ WARNING: the ``nan_as_null`` parameter will be removed from the API protocol.
408
+ Please avoid passing it as either a positional or keyword argument. Call this
409
+ method using ``.__dataframe__(allow_copy=...)``.
408
410
"""
409
411
pass
410
412
You can’t perform that action at this time.
0 commit comments