Skip to content

Commit 19e1a86

Browse files
committed
Clarify that buttercup--wrap-expr is only meant for expect
The butercup--wrap-expr function was extracted from the expect macro to reduce code repetition in that macro definition. It will not produce a function when used outside that - or possibly other - macros.
1 parent 9bb00a2 commit 19e1a86

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

buttercup.el

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,8 @@ Does not have the IGNORE-MISSING and SPLIT parameters."
185185
(define-error 'buttercup-pending "Buttercup test is pending" 'buttercup-error-base)
186186

187187
(defun buttercup--wrap-expr (expr)
188-
"Wrap EXPR in a `buttercup--thunk' to be used by `buttercup-expect'."
188+
"Wrap EXPR in a `buttercup--thunk' to be used by `buttercup-expect'.
189+
This function is only usable from within the buttercup `expect' macro."
189190
(if (fboundp 'oclosure-lambda) ;Emacs≥29
190191
`(oclosure-lambda (buttercup--thunk (expr ',expr)) ()
191192
,expr)

0 commit comments

Comments
 (0)