GNU bug report logs - #30792
26.0.91; improve docstring of with-help-window

Previous Next

Full log

View this message in rfc822 format

From: martin rudalics <rudalics <at> gmx.at>
To: Nick Helm <nick <at> tenpoint.co.nz>, Eli Zaretskii <eliz <at> gnu.org>
Cc: 30792 <at> debbugs.gnu.org
Subject: bug#30792: 26.0.91; improve docstring of with-help-window
Date: Wed, 14 Mar 2018 09:14:33 +0100

>> It strikes me that instead of repeating most of what
>> with-temp-buffer-window's doc string says, it might be better to
>> simply refer to there.  Like this:
>>
>>    Display the output produced by evaluating BODY, like
>>    `with-temp-buffer-window' does, then put the window in
>>    `help-mode' [...]

Neither `with-temp-buffer-window' nor `help-mode' are of any relevance
here.  The distinctive aspect of `with-help-window' is provided by
`help-window-setup' which sets up the help window for quitting it
later.  Earlier macros failed miserably in this regard.  (I have to
admit that many people are still ignorant of this fact and believe
they could resolve the quitting problem by saving and restoring window
configurations.  So the old doc-string probably failed to provide this
rather crucial information as well.)

> +This construct is like `with-current-buffer-window' but unlike that

IIUC it does not make the buffer current when running BODY.

martin

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.