summaryrefslogtreecommitdiff
path: root/test
diff options
context:
space:
mode:
authorTassilo Horn <tsdh@gnu.org>2015-09-10 21:11:18 +0200
committerTassilo Horn <tsdh@gnu.org>2015-09-10 21:12:23 +0200
commit5a92d97802e095c541a644bdaca00755942af821 (patch)
treeb8565340e2fc01d0c369a7e550e77cdc76e2a098 /test
parent5f334658668eef0fd3c11d24167437fbd5cb3fc1 (diff)
downloademacs-5a92d97802e095c541a644bdaca00755942af821.tar.gz
Document file-notify--test-with-events.
* test/automated/file-notify-tests.el (file-notify--test-with-events): Add docstring.
Diffstat (limited to 'test')
-rw-r--r--test/automated/file-notify-tests.el2
1 files changed, 2 insertions, 0 deletions
diff --git a/test/automated/file-notify-tests.el b/test/automated/file-notify-tests.el
index 9831afd1d20..99b0ebc9283 100644
--- a/test/automated/file-notify-tests.el
+++ b/test/automated/file-notify-tests.el
@@ -247,6 +247,8 @@ TIMEOUT is the maximum time to wait for, in seconds."
(read-event nil nil 0.1))))
(defmacro file-notify--test-with-events (n timeout assert-fn &rest body)
+ "Run BODY collecting N events and then run ASSERT-FN.
+Don't wait longer than TIMEOUT seconds for the events to be delivered."
(declare (indent 3))
(let ((outer (make-symbol "outer")))
`(let ((,outer file-notify--test-events))