From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 30 Apr 2016 18:16:25 +0000 (+0200)
Subject: add-timeout doc fix
X-Git-Tag: emacs-25.0.94~76
X-Git-Url: https://code.delx.au/gnu-emacs/commitdiff_plain/bbda22c6406ca6647626ea210292c7a279c80810

add-timeout doc fix

* lisp/emacs-lisp/timer.el (add-timeout): Mention the return
value (bug#20181).

(cherry picked from commit 921b40476f597c84d7c34aa289cd43caeb389c4a)
---

diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el
index 3f2e2fb528..c01ea4973c 100644
--- a/lisp/emacs-lisp/timer.el
+++ b/lisp/emacs-lisp/timer.el
@@ -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))