branch: elpa/with-simulated-input
commit 004218b75c318557fe03b457ad418f2c80704e93
Author: Ryan C. Thompson <[email protected]>
Commit: Ryan C. Thompson <[email protected]>
Add more info to docstring for wsi-simulated-idle-time
---
with-simulated-input.el | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/with-simulated-input.el b/with-simulated-input.el
index 5eb8bdf8c8..f34df0c2ed 100644
--- a/with-simulated-input.el
+++ b/with-simulated-input.el
@@ -225,9 +225,11 @@ simulated idle time to be returned instead of the real
value."
"Run all idle timers with delay less than SECS.
This simulates resetting the idle time to zero and then being
-idle for SECS seconds. If ACTUALLY-WAIT is non-nil, this function
-will also wait for the specified amount of time before running
-each timers.
+idle for SECS seconds. Hence calling this function twice with
+SECS = 1 is not equivalent to 2 seconds of idle time.
+
+If ACTUALLY-WAIT is non-nil, this function will also wait for the
+specified amount of time before running each timer.
If SECS is nil, simulate enough idle time to run each timer in
`timer-idle-list' at least once. (It's possible that some timers
