[nongnu] elpa/buttercup 19e1a86626 14/16: Clarify that buttercup--wrap-expr is only meant for expect

[ELPA Syncer]

branch: elpa/buttercup
commit 19e1a866265517104ff402bf27fb73f73ebfc627
Author: Ola Nilsson <ola.nils...@gmail.com>
Commit: Ola Nilsson <ola.nils...@gmail.com>

    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.
---
 buttercup.el | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/buttercup.el b/buttercup.el
index 68f4e6d083..702192a7ef 100644
--- a/buttercup.el
+++ b/buttercup.el
@@ -185,7 +185,8 @@ Does not have the IGNORE-MISSING and SPLIT parameters."
 (define-error 'buttercup-pending "Buttercup test is pending" 
'buttercup-error-base)
 
 (defun buttercup--wrap-expr (expr)
-  "Wrap EXPR in a `buttercup--thunk' to be used by `buttercup-expect'."
+  "Wrap EXPR in a `buttercup--thunk' to be used by `buttercup-expect'.
+This function is only usable from within the buttercup `expect' macro."
   (if (fboundp 'oclosure-lambda)        ;Emacs≥29
       `(oclosure-lambda (buttercup--thunk (expr ',expr)) ()
          ,expr)