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 9831afd1d2024ec4cc5db512e740da34d785bd48..99b0ebc928342dc2223b25a8dcd3307887495699 100644 (file)
--- 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))