[Emacs-diffs] master 8b47daa: * lisp/emacs-lisp/thunk.el: Better documentation.

[Nicolas Petton]

branch: master
commit 8b47daab5ce7da394a057f40aa2738b6c204c2f5
Author: Nicolas Petton <address@hidden>
Commit: Nicolas Petton <address@hidden>

    * lisp/emacs-lisp/thunk.el: Better documentation.
---
 lisp/emacs-lisp/thunk.el |   19 +++++++++++++++----
 1 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/lisp/emacs-lisp/thunk.el b/lisp/emacs-lisp/thunk.el
index ab366d2..d07b257 100644
--- a/lisp/emacs-lisp/thunk.el
+++ b/lisp/emacs-lisp/thunk.el
@@ -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