Add :to-be-close-to docstring

snogge · Aug 27, 2024 · 6ecee3c · 6ecee3c
1 parent 315d76f
commit 6ecee3c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/buttercup.el b/buttercup.el
@@ -614,6 +614,8 @@ See also `buttercup-define-matcher'."
   :expect-mismatch-phrase "Expected `%A' < %b, but `%A' was %a.")
 
 (buttercup-define-matcher :to-be-close-to (a b precision)
+  "Verify that |A-B| < 10^-PRECISION.
+\(expect A :to-be-close-to B PRECISION)"
   (cl-destructuring-bind
       (precision (a-expr . a) (_b-expr . b))
       (cons (funcall precision)