; * lisp/subr.el (sit-for): Doc fix.
authorEli Zaretskii <eliz@gnu.org>
Thu, 30 Jan 2025 09:37:40 +0000 (11:37 +0200)
committerEli Zaretskii <eliz@gnu.org>
Thu, 30 Jan 2025 09:37:40 +0000 (11:37 +0200)
lisp/subr.el

index 9666cc09a5c5182f80c0b9b49f7604f58994d310..7aca542dab46d0c59701c8fd04465bae77bad86e 100644 (file)
@@ -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: