From: Alan Mackenzie <acm@muc.de>
To: 19381@debbugs.gnu.org
Subject: bug#19381: The doc string for `sit-for' is wrong; redisplay isn't unconditionally done.
Date: Sun, 14 Dec 2014 17:13:50 +0000 [thread overview]
Message-ID: <20141214171350.GA2606@acm.acm> (raw)
Hello, Emacs.
The doc string for `sit-for', in its first (and most important) line
states unequivocally that redisplay is performed. (That line is "Perform
redisplay, then wait for SECONDS seconds or until input is available.")
That's not what the function currently does - it doesn't perform
redisplay if input is already available when it is called.
A sentence lower down in the doc string contradicts its first line
("Redisplay does not happen if input is available before it starts.").
There is thus a clash between the doc-string and the code. (The info
page agrees with the code).
It would seem at first sight that the obvious thing to do is correct the
first line of the doc string. However there are lots (125) of instances
of "(sit-for 0)" in Emacs, and a lot of these are probably intended to
mean "perform redisplay NOW". So it might be better to make `sit-for'
always do a redisplay.
However it's done, though, the clash between the doc string and
everything else should be resolved.
--
Alan Mackenzie (Nuremberg, Germany).
next reply other threads:[~2014-12-14 17:13 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-14 17:13 Alan Mackenzie [this message]
2014-12-14 23:31 ` bug#19381: The doc string for `sit-for' is wrong; redisplay isn't unconditionally done Stefan Monnier
2014-12-15 10:35 ` Alan Mackenzie
2014-12-15 14:41 ` Stefan Monnier
2014-12-15 18:50 ` Stefan Monnier
2014-12-16 17:00 ` Alan Mackenzie
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20141214171350.GA2606@acm.acm \
--to=acm@muc.de \
--cc=19381@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.