Skip to content

Commit

Permalink
Improve docstring of buttercup-define-matcher
Browse files Browse the repository at this point in the history
  • Loading branch information
snogge committed Sep 4, 2024
1 parent 789570c commit a1d0d73
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions buttercup.el
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a1d0d73

Please sign in to comment.