summaryrefslogtreecommitdiff
path: root/lisp/subr.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2025-01-30 11:37:40 +0200
committerEli Zaretskii <eliz@gnu.org>2025-01-30 11:37:40 +0200
commitd11488fd6fb72acd9f9356b95b2f905c59a1095d (patch)
treea68709d7120435644ce5539b0facf1efa312e995 /lisp/subr.el
parent0b3e050c6ce07e7b87aaab1185f605a1d8c16ba1 (diff)
downloademacs-d11488fd6fb72acd9f9356b95b2f905c59a1095d.tar.gz
emacs-d11488fd6fb72acd9f9356b95b2f905c59a1095d.tar.bz2
emacs-d11488fd6fb72acd9f9356b95b2f905c59a1095d.zip
; * lisp/subr.el (sit-for): Doc fix.
Diffstat (limited to 'lisp/subr.el')
-rw-r--r--lisp/subr.el8
1 files changed, 5 insertions, 3 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 9666cc09a5c..7aca542dab4 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -3529,13 +3529,15 @@ causes it to evaluate `help-form' and display the result."
char))
(defun sit-for (seconds &optional nodisp)
- "Redisplay, then wait for SECONDS seconds. Stop when input is available.
+ "Redisplay, then wait for SECONDS seconds; stop when input is available.
SECONDS may be a floating-point value.
\(On operating systems that do not support waiting for fractions of a
second, floating-point values are rounded down to the nearest integer.)
-If optional arg NODISP is t, don't redisplay, just wait for input.
-Redisplay does not happen if input is available before it starts.
+If there's pending input, return nil immediately without redisplaying
+and without waiting.
+If optional arg NODISP is t, don't redisplay, just wait for input (but
+still return nil immediately if there's pending input).
Value is t if waited the full time with no input arriving, and nil otherwise."
;; This used to be implemented in C until the following discussion: