branch: elpa/buttercup
commit a1d0d739992daf61fa91b02fd46ce814af0d3467
Author: Ola Nilsson <ola.nils...@gmail.com>
Commit: Ola Nilsson <ola.nils...@gmail.com>
Improve docstring of buttercup-define-matcher
---
buttercup.el | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/buttercup.el b/buttercup.el
index 3fc51db26a..82a1dd80d8 100644
--- a/buttercup.el
+++ b/buttercup.el
@@ -263,16 +263,16 @@ MESSAGE is omitted or nil show the condition form
instead."
(defmacro buttercup-define-matcher (matcher args &rest body)
"Define a matcher named MATCHER to be used in `expect'.
-
+MATCHER is a keyword, for instance `:to-be'.
ARGS is a list of the elements to match together.
-
The BODY will receive ARGS as functions that can be called (using
`funcall') to get their values. BODY should return either a
simple boolean, or a cons cell of the form (RESULT . MESSAGE). If
RESULT is nil, MESSAGE should describe why the matcher failed. If
RESULT is non-nil, MESSAGE should describe why a negated matcher
failed.
-BODY may start with a docstring."
+
+\(fn MATCHER ARGS [DOCSTRING] BODY...)"
(declare (indent defun))
`(put ,matcher 'buttercup-matcher
(lambda ,args
