summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/timer.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2016-04-30 20:16:25 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2016-04-30 20:32:56 +0200
commit921b40476f597c84d7c34aa289cd43caeb389c4a (patch)
treeef633a6c5173961dc680bb6d7f655b72f1e3521d /lisp/emacs-lisp/timer.el
parent6c7e7f421d02d9290d6d1d85320737371160aef7 (diff)
downloademacs-921b40476f597c84d7c34aa289cd43caeb389c4a.tar.gz
add-timeout doc fix
* lisp/emacs-lisp/timer.el (add-timeout): Mention the return value (bug#20181).
Diffstat (limited to 'lisp/emacs-lisp/timer.el')
-rw-r--r--lisp/emacs-lisp/timer.el2
1 files changed, 2 insertions, 0 deletions
diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el
index 3f2e2fb5286..c01ea4973c7 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))