From: "Stephen J. Turnbull" <turnbull@sk.tsukuba.ac.jp>
To: Drew Adams <drew.adams@oracle.com>
Cc: Leo Liu <sdl.web@gmail.com>, emacs-devel@gnu.org
Subject: RE: with-output-to-temp-buffer and help-mode
Date: Sat, 26 Jul 2014 10:10:25 +0900 [thread overview]
Message-ID: <87a97worge.fsf@uwakimon.sk.tsukuba.ac.jp> (raw)
In-Reply-To: <61a1087c-3e21-46df-a12c-22dce14e82b1@default>
Drew Adams writes:
> No. Please read what I wrote.
tl;dr
Your point is actually rather subtle (though the general outline is
well-known), and some important ideas were left implicit. I don't
really quarrel with the notion that long-timers on this list probably
should "get" it without it being made explicit, but if not, don't put
the burden on the reader. Not everybody is a long-time reader, and
not all of the long-timers will necessarily have their heads in the
right place.
Rather than argue who said what, point by point, here's the argument
in much more explicit form.
1. The "traditional" implementation of `with-output-to-temp-buffer'
provides (by default, and without option) many features to support
help-mode. (Fact: nobody argues with this.)
2. Use cases where those features are important are in fact common,
both in Emacs and in third-party code.
3. The argument does not depend at all on the existence or frequency
of use cases that don't use the help features. Where they
actually get in the way, it's probably rarely visible to the user
as existing code has *already* worked around those issues.
4. Because of (2), backward-compatibility demands that the
traditional name continue to have these traditional semantics --
any change causes widespread breakage, not all of which is
possible to fix. (Leo seems to be ignoring this.)
5. The strategy to deal with this (provide a new alias indicating the
traditional semantics properly, and a new function with an
appropriate name to indicate the non-help semantics) is
well-known, is well-known to have worked well in similar
circumstances, and should be adopted here, too.
We even know *why* it works well: because of (3), only new code
has need for the new function, and in new code it's almost as easy
to use a function with a new name as the documentation for the
"obvious" name will indicate that it's a backward compatibility
kludge.
6. Accept that the "best" name for the new function is unavailable,
and move on. (This seems to be hard for many developers to do,
not just in Emacs. ;-)
7. Implementation strategy (duplicate the simple logic for a non-help
buffer, reimplement `with-output-to-temp-buffer' using the new
function, something else) is up to the implementer. (Of course.)
It's true that you've written almost all of that, almost all in
equivalent words, but it's spread over many more lines and several
posts.
next prev parent reply other threads:[~2014-07-26 1:10 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-07-25 8:15 with-output-to-temp-buffer and help-mode Glenn Morris
2014-07-25 9:06 ` Leo Liu
2014-07-25 15:34 ` Drew Adams
2014-07-25 18:12 ` Leo Liu
2014-07-25 19:06 ` Drew Adams
2014-07-26 1:10 ` Stephen J. Turnbull [this message]
2014-07-26 9:00 ` martin rudalics
2014-07-26 1:30 ` Glenn Morris
2014-07-26 1:39 ` Glenn Morris
2014-07-26 3:33 ` Thien-Thi Nguyen
2014-08-05 8:35 ` Glenn Morris
2014-08-06 16:54 ` Stefan Monnier
2014-08-07 3:30 ` Leo Liu
2014-07-25 15:13 ` Drew Adams
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87a97worge.fsf@uwakimon.sk.tsukuba.ac.jp \
--to=turnbull@sk.tsukuba.ac.jp \
--cc=drew.adams@oracle.com \
--cc=emacs-devel@gnu.org \
--cc=sdl.web@gmail.com \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).