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

Previous Next

Full log

Message #29 received at 30792 <at> debbugs.gnu.org (full text, mbox):

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

>> Neither `with-temp-buffer-window' nor `help-mode' are of any relevance
>> here.
>
> ??? with-help-window is a thin wrapper around with-temp-buffer-window.

I confused `with-temp-buffer-window' and `with-output-to-temp-buffer'.
It's the former that sets up the quitting mechanism.

>> The distinctive aspect of `with-help-window' is provided by
>> `help-window-setup' which sets up the help window for quitting it
>> later.
>
> Indeed,

... not really, as mentioned abbove ...

> which is why I think the modified doc string should keep the
> part of the existing doc string which tells about this special setup.

The comment before the definition of `with-help-window' says what it
does additionally.  It think it's really not necessary to say it in
the doc-string.

But if we change BUFFER-NAME to BUFFER-OR-NAME this should be
reflected in the Elisp manual.

martin

Previous Next

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