]> code.delx.au - gnu-emacs/commitdiff
add-timeout doc fix
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 30 Apr 2016 18:16:25 +0000 (20:16 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 1 May 2016 17:27:14 +0000 (19:27 +0200)
* lisp/emacs-lisp/timer.el (add-timeout): Mention the return
value (bug#20181).

(cherry picked from commit 921b40476f597c84d7c34aa289cd43caeb389c4a)

lisp/emacs-lisp/timer.el

index 3f2e2fb5286c50f29dd69798619aee36b388f076..c01ea4973c72a451102ce2127a92096c7dbfd4b9 100644 (file)
@@ -424,6 +424,8 @@ This function returns a timer object which you can use in `cancel-timer'."
 (defun add-timeout (secs function object &optional repeat)
   "Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT.
 If REPEAT is non-nil, repeat the timer every REPEAT seconds.
+
+This function returns a timer object which you can use in `cancel-timer'.
 This function is for compatibility; see also `run-with-timer'."
   (run-with-timer secs repeat function object))