Document file-notify--test-with-events.

* test/automated/file-notify-tests.el (file-notify--test-with-events):
Add docstring.
This commit is contained in:
Tassilo Horn 2015-09-10 21:11:18 +02:00
parent 5f33465866
commit 5a92d97802

View file

@ -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))