diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-30 20:16:25 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2016-05-01 19:27:14 +0200 |
| commit | bbda22c6406ca6647626ea210292c7a279c80810 (patch) | |
| tree | 4e1c43c1ffcce8b9909b4819c84f7ce63db7f897 /lisp/emacs-lisp/timer.el | |
| parent | 818fb69bd2b48a4ba6359659383ab3e5e8ab6cb1 (diff) | |
| download | emacs-bbda22c6406ca6647626ea210292c7a279c80810.tar.gz emacs-bbda22c6406ca6647626ea210292c7a279c80810.tar.bz2 emacs-bbda22c6406ca6647626ea210292c7a279c80810.zip | |
add-timeout doc fix
* lisp/emacs-lisp/timer.el (add-timeout): Mention the return
value (bug#20181).
(cherry picked from commit 921b40476f597c84d7c34aa289cd43caeb389c4a)
Diffstat (limited to 'lisp/emacs-lisp/timer.el')
| -rw-r--r-- | lisp/emacs-lisp/timer.el | 2 |
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)) |