From: Tassilo Horn <tsdh@gnu.org>
Date: Thu, 10 Sep 2015 19:11:18 +0000 (+0200)
Subject: Document file-notify--test-with-events.
X-Git-Tag: emacs-25.0.90~1224^2~157
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=5a92d97802e095c541a644bdaca00755942af821;p=emacs.git

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

* test/automated/file-notify-tests.el (file-notify--test-with-events):
Add docstring.
---

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