updating docs for Inconsistent Behavior with math_epsilon and

ignore_order. Fixes #431

Author: seperman

deepdiff/diff.py

@@ -231,7 +231,7 @@ def _group_by_sort_key(x):
             self.significant_digits = self.get_significant_digits(significant_digits, ignore_numeric_type_changes)
             self.math_epsilon = math_epsilon
             if self.math_epsilon is not None and self.ignore_order:
-                logger.warning("math_epsilon will be ignored. It cannot be used when ignore_order is True.")
+                logger.warning("math_epsilon in conjunction with ignore_order=True is only used for flat object comparisons. Custom math_epsilon will not have an effect when comparing nested objects.")
             self.truncate_datetime = get_truncate_datetime(truncate_datetime)
             self.number_format_notation = number_format_notation
             if verbose_level in {0, 1, 2}:

tests/test_diff_text.py

@@ -2008,4 +2008,3 @@ class Bar(PydanticBaseModel):
         diff = DeepDiff(t1, t2)
         expected = {'values_changed': {'root.stuff[0].thing': {'new_value': 2, 'old_value': 1}}}
         assert expected == diff
-

tests/test_ignore_order.py

@@ -897,6 +897,32 @@ def test_ignore_order_and_group_by4(self):
 
         assert expected == diff
 
+    def test_math_epsilon_when_ignore_order_in_dictionary(self):
+        a = {'x': 0.001}
+        b = {'x': 0.0011}
+        diff = DeepDiff(a, b, ignore_order=True)
+        assert {'values_changed': {"root['x']": {'new_value': 0.0011, 'old_value': 0.001}}} == diff
+
+        diff2 = DeepDiff(a, b, ignore_order=True, math_epsilon=0.01)
+        assert {} == diff2
+
+    def test_math_epsilon_when_ignore_order_in_list(self):
+        a = [0.001, 2]
+        b = [2, 0.0011]
+        diff = DeepDiff(a, b, ignore_order=True)
+        assert {'values_changed': {'root[0]': {'new_value': 0.0011, 'old_value': 0.001}}} == diff
+
+        diff2 = DeepDiff(a, b, ignore_order=True, math_epsilon=0.01)
+        assert {} == diff2
+
+    def test_math_epsilon_when_ignore_order_in_nested_list(self):
+        a = [{'x': 0.001}, {'y': 2.00002}]
+        b = [{'x': 0.0011}, {'y': 2}]
+
+        diff = DeepDiff(a, b, ignore_order=True, math_epsilon=0.01)
+        expected = {'values_changed': {'root[0]': {'new_value': {'x': 0.0011}, 'old_value': {'x': 0.001}}, 'root[1]': {'new_value': {'y': 2}, 'old_value': {'y': 2.00002}}}}
+        assert expected == diff
+
 
 class TestCompareFuncIgnoreOrder: