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: Eli Zaretskii <eliz <at> gnu.org>
To: Nick Helm <nick <at> tenpoint.co.nz>
Cc: 30792 <at> debbugs.gnu.org
Subject: bug#30792: 26.0.91; improve docstring of with-help-window
Date: Wed, 14 Mar 2018 17:56:26 +0200

> From: Nick Helm <nick <at> tenpoint.co.nz>
> Cc: 30792 <at> debbugs.gnu.org
> Date: Wed, 14 Mar 2018 13:09:15 +1300
> 
> On Wed, 14 Mar 2018 at 05:53:32 +1300, Eli Zaretskii wrote:
> 
> > 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' [...]
> 
> Ok, how's this? (wording borrowed from other macros that use
> `with-temp-buffer-window'):

OK, but I think you should mention this part of the old doc string:

  and issue a message how to deal with that \"help\" window when it's
  no more needed

Previous Next

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