Skip to content

Commit 8739ddd

Browse files
committed
better docstring
1 parent e84cc97 commit 8739ddd

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

xarray/core/duck_array_ops.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,9 @@ def allclose_or_equiv(arr1, arr2, rtol=1e-5, atol=1e-8):
193193

194194

195195
def lazy_array_equiv(arr1, arr2):
196-
"""Like array_equal, but doesn't actually compare values
196+
"""Like array_equal, but doesn't actually compare values.
197+
Returns True or False when equality can be determined without computing.
198+
Returns None when equality cannot determined (e.g. one or both of arr1, arr2 are numpy arrays)
197199
"""
198200
arr1 = asarray(arr1)
199201
arr2 = asarray(arr2)

0 commit comments

Comments
 (0)