[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 6f7e99f 1/2: Document run-with-timer
From: |
Lars Ingebrigtsen |
Subject: |
master 6f7e99f 1/2: Document run-with-timer |
Date: |
Tue, 29 Oct 2019 17:53:10 -0400 (EDT) |
branch: master
commit 6f7e99fb1896b1414187d98b4b1459d04ac94823
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>
Document run-with-timer
* doc/lispref/os.texi (Timers): Mention run-with-timer (bug#37875).
---
doc/lispref/os.texi | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 93551ca..d8d0ad7 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -2109,6 +2109,13 @@ 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,
but remember that any invocation of a timer can be late. Lateness of
one repetition has no effect on the scheduled time of the next