]> git.eshelyaron.com Git - emacs.git/commitdiff
Document run-with-timer
authorLars Ingebrigtsen <larsi@gnus.org>
Tue, 29 Oct 2019 21:22:25 +0000 (22:22 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Tue, 29 Oct 2019 21:22:25 +0000 (22:22 +0100)
* doc/lispref/os.texi (Timers): Mention run-with-timer (bug#37875).

doc/lispref/os.texi

index 93551cab0e5dad4510f15482f3e07eee956beba3..d8d0ad7206d920dc0e799997b04bfef6793ab38e 100644 (file)
@@ -2107,6 +2107,13 @@ functions like @code{display-time}.
 The function @code{run-at-time} returns a timer value that identifies
 the particular scheduled future action.  You can use this value to call
 @code{cancel-timer} (see below).
+@end deffn
+
+@deffn Command run-with-timer secs repeat function &rest args
+This is exactly the same as @code{run-at-time} (so see that definition
+for an explanation of the parameters; @var{secs} is passed as
+@var{time} to that function), but is meant to be used when the delay
+is specified in seconds.
 @end deffn
 
   A repeating timer nominally ought to run every @var{repeat} seconds,