mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-02 11:21:42 +00:00
Code Issues Releases Activity

add-timeout doc fix

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

(cherry picked from commit 921b40476f)
This commit is contained in:
Lars Ingebrigtsen 2016-04-30 20:16:25 +02:00
parent 818fb69bd2
commit bbda22c640
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lisp/emacs-lisp/timer.el
View 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) (defun add-timeout (secs function object &optional repeat)
"Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT. "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. 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'." This function is for compatibility; see also `run-with-timer'."
(run-with-timer secs repeat function object)) (run-with-timer secs repeat function object))