procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* lisp/emacs-lisp/thunk.el: Better documentation.

Browse source
This commit is contained in:
Nicolas Petton 2015-10-23 18:06:54 +02:00
parent 8408f4e38c
commit 8b47daab5c
1 changed files with 15 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

19
lisp/emacs-lisp/thunk.el
View file

@ -26,10 +26,21 @@
;;; Commentary:
;;
;; Thunk provides functions and macros to control the evaluation of
;; forms. Use `thunk-delay' to delay the evaluation of a form, and
;; `thunk-force' to evaluate it. Evaluation is cached, and only
;; happens once.
;; Thunk provides functions and macros to delay the evaluation of
;; forms.
;;
;; Use `thunk-delay' to delay the evaluation of a form, and
;; `thunk-force' to evaluate it. The result of the evaluation is
;; cached, and only happens once.
;;
;; Here is an example of a form which evaluation is delayed:
;;
;; (setq delayed (thunk-delay (message "this message is delayed")))
;;
;; `delayed' is not evaluated until `thunk-force' is called, like the
;; following:
;;
;; (thunk-force delayed)
;; Tests are located at test/automated/thunk-tests.el