From 8739dddb12cd026d9073f60c01b1c3b81c80a072 Mon Sep 17 00:00:00 2001 From: dcherian Date: Mon, 28 Oct 2019 08:32:15 -0600 Subject: [PATCH] better docstring --- xarray/core/duck_array_ops.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/xarray/core/duck_array_ops.py b/xarray/core/duck_array_ops.py index c2b72eb08e1..7c0b730814e 100644 --- a/xarray/core/duck_array_ops.py +++ b/xarray/core/duck_array_ops.py @@ -193,7 +193,9 @@ def allclose_or_equiv(arr1, arr2, rtol=1e-5, atol=1e-8): def lazy_array_equiv(arr1, arr2): - """Like array_equal, but doesn't actually compare values + """Like array_equal, but doesn't actually compare values. + Returns True or False when equality can be determined without computing. + Returns None when equality cannot determined (e.g. one or both of arr1, arr2 are numpy arrays) """ arr1 = asarray(arr1) arr2 = asarray(arr2)