]> code.delx.au - gnu-emacs/commitdiff
Improve the doc string of w32notify-valid-p
authorEli Zaretskii <eliz@gnu.org>
Mon, 14 Sep 2015 09:41:51 +0000 (12:41 +0300)
committerEli Zaretskii <eliz@gnu.org>
Mon, 14 Sep 2015 09:41:51 +0000 (12:41 +0300)
* src/w32notify.c (Fw32notify_valid_p): Mention in the doc string
that removing a watch makes its object invalid.

src/w32notify.c

index efd9e56e10569a79316942f2500b7d51c7939868..a6b5c1908a148bf709c5628c361d6a1e5e9c6d3b 100644 (file)
@@ -649,7 +649,8 @@ DEFUN ("w32notify-valid-p", Fw32notify_valid_p, Sw32notify_valid_p, 1, 1, 0,
 WATCH-DESCRIPTOR should be an object returned by `w32notify-add-watch'.
 
 A watch can become invalid if the directory it watches is deleted, or if
-the watcher thread exits abnormally for any other reason.  */)
+the watcher thread exits abnormally for any other reason.  Removing the
+watch by calling `w32notify-rm-watch' also makes it invalid.  */)
      (Lisp_Object watch_descriptor)
 {
   Lisp_Object watch_object = Fassoc (watch_descriptor, watch_list);