From: Alan Mackenzie <acm@muc.de>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 19381-done@debbugs.gnu.org
Subject: bug#19381: The doc string for `sit-for' is wrong; redisplay isn't unconditionally done.
Date: Tue, 16 Dec 2014 17:00:23 +0000 [thread overview]
Message-ID: <20141216170023.GB3134@acm.acm> (raw)
In-Reply-To: <jwvegs0lpnc.fsf-monnier+emacsbugs@gnu.org>
Hello, Stefan.
On Mon, Dec 15, 2014 at 01:50:25PM -0500, Stefan Monnier wrote:
> > 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.
> I've changed it to say:
> "Redisplay, then wait for SECONDS seconds. Stop when input is available.
Thanks, that's better. It's an awkward thing to have to squeeze into
one line.
> So that the "when input is available" part is not so closely tied to
> the "wait" part but can also apply to the "redisplay" part.
> > 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.
> While fixing the docstring, I also saw that the code of sit-for hints
> at the solution to the above problem: if you just want to redisplay,
> don't call (sit-for 0), but call `redisplay' instead (where the `force'
> argument can be used to decide whether pending input should prevent
> redisplay or not).
Yes. There are 17 calls to `redisplay' in Emacs. Of the 125 "(sit-for
0)"s, a lot of them will be wanting redisplay, but are being called in
the context of a user typing individual keys. (This is certainly the
case in edebug.el, for example.) So, it doesn't matter too much.
> Stefan
--
Alan Mackenzie (Nuremberg, Germany).
prev parent reply other threads:[~2014-12-16 17:00 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-14 17:13 bug#19381: The doc string for `sit-for' is wrong; redisplay isn't unconditionally done Alan Mackenzie
2014-12-14 23:31 ` 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 [this message]
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=20141216170023.GB3134@acm.acm \
--to=acm@muc.de \
--cc=19381-done@debbugs.gnu.org \
--cc=monnier@iro.umontreal.ca \
/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.