[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master 921b404 2/5: add-timeout doc fix
From: |
Lars Ingebrigtsen |
Subject: |
[Emacs-diffs] master 921b404 2/5: add-timeout doc fix |
Date: |
Sat, 30 Apr 2016 18:33:03 +0000 |
branch: master
commit 921b40476f597c84d7c34aa289cd43caeb389c4a
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>
add-timeout doc fix
* lisp/emacs-lisp/timer.el (add-timeout): Mention the return
value (bug#20181).
---
lisp/emacs-lisp/timer.el | 2 ++
1 file changed, 2 insertions(+)
diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el
index 3f2e2fb..c01ea49 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))