[elpa] externals/assess d809f70748 53/95: Documentation for `assess-call--capture-lambda`

[ELPA Syncer]

branch: externals/assess
commit d809f7074889b892de7b23087eb70205b4ae74d6
Author: Phillip Lord <phillip.lord@russet.org.uk>
Commit: Phillip Lord <phillip.lord@russet.org.uk>

    Documentation for `assess-call--capture-lambda`
---
 assess-call.el | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/assess-call.el b/assess-call.el
index cd5c35f54e..6cd0b3997a 100644
--- a/assess-call.el
+++ b/assess-call.el
@@ -63,6 +63,12 @@
     rtn))
 
 (defun assess-call--capture-lambda ()
+  "Return function which captures args and returns of another.
+
+The returned function takes FN the function to call, and any
+number of ARGS to call the function with. In the special case,
+that FN is equal to `:return`, then all previous args and return
+values of FN are returned instead."
   (let ((capture-store nil))
     (lambda (fn &rest args)
       (if (eq fn :return)