[Emacs-diffs] master 5a92d97: Document file-notify--test-with-events.

[Tassilo Horn]

branch: master
commit 5a92d97802e095c541a644bdaca00755942af821
Author: Tassilo Horn <address@hidden>
Commit: Tassilo Horn <address@hidden>

    Document file-notify--test-with-events.
    
    * test/automated/file-notify-tests.el (file-notify--test-with-events):
    Add docstring.
---
 test/automated/file-notify-tests.el |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/test/automated/file-notify-tests.el 
b/test/automated/file-notify-tests.el
index 9831afd..99b0ebc 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))