bug#761: 23.0.60; doc for temp-buffer-show-hook

bug#761: 23.0.60; doc for temp-buffer-show-hook

[Drew Adams]

emacs -Q
 
The doc string and Elisp manual both say exactly the same thing for
`temp-buffer-show-hook'. This part of that text should be removed:
 
"This hook is normally set up with a function to make
the buffer read only, and find function names and variable names
in it, provided the major mode is Help mode."
 
It's just not true. Looking at the Emacs source code that sets
`temp-buffer-show-hook', not to mention third-party code that sets it,
this part of the text is not appropriate. "Normally" does not apply
here, and neither does "typically" or anything else.
 
All that should be said is said in the first part of the text: "Normal
hook run by `with-output-to-temp-buffer' after displaying the buffer.
When the hook runs, the temporary buffer is current, and the window it
was displayed in is selected." You can use it for anything you want
to.
 
Also, the manual just duplicates the doc string verbatim. Is there
nothing else to say?
 
 
 
In GNU Emacs 23.0.60.1 (i386-mingw-nt5.1.2600)
 of 2008-08-01 on LENNART-69DE564
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include
-fno-crossjumping'
 

bug#761: marked as done (23.0.60; doc for temp-buffer-show-hook)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 835 bytes --]


Your message dated Fri, 22 Aug 2008 23:06:17 -0400
with message-id <874p5csa52.fsf@cyd.mit.edu>
and subject line Re: 23.0.60; doc for temp-buffer-show-hook
has caused the Emacs bug report #761,
regarding 23.0.60; doc for temp-buffer-show-hook
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact don@donarmstrong.com
immediately.)


-- 
761: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=761
Emacs Bug Tracking System
Contact don@donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 3829 bytes --]

From: "Drew Adams" <drew.adams@oracle.com>
To: <emacs-pretest-bug@gnu.org>
Subject: 23.0.60; doc for temp-buffer-show-hook
Date: Fri, 22 Aug 2008 13:32:32 -0700
Message-ID: <003701c90496$34b4f610$0200a8c0@us.oracle.com>

emacs -Q
 
The doc string and Elisp manual both say exactly the same thing for
`temp-buffer-show-hook'. This part of that text should be removed:
 
"This hook is normally set up with a function to make
the buffer read only, and find function names and variable names
in it, provided the major mode is Help mode."
 
It's just not true. Looking at the Emacs source code that sets
`temp-buffer-show-hook', not to mention third-party code that sets it,
this part of the text is not appropriate. "Normally" does not apply
here, and neither does "typically" or anything else.
 
All that should be said is said in the first part of the text: "Normal
hook run by `with-output-to-temp-buffer' after displaying the buffer.
When the hook runs, the temporary buffer is current, and the window it
was displayed in is selected." You can use it for anything you want
to.
 
Also, the manual just duplicates the doc string verbatim. Is there
nothing else to say?
 
 
 
In GNU Emacs 23.0.60.1 (i386-mingw-nt5.1.2600)
 of 2008-08-01 on LENNART-69DE564
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include
-fno-crossjumping'
 




[-- Attachment #3: Type: message/rfc822, Size: 1149 bytes --]

From: Chong Yidong <cyd@stupidchicken.com>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 761-done@emacsbugs.donarmstrong.com
Subject: Re: 23.0.60; doc for temp-buffer-show-hook
Date: Fri, 22 Aug 2008 23:06:17 -0400
Message-ID: <874p5csa52.fsf@cyd.mit.edu>

Okay, I've removed the offending sentence from the docstring and the
lispref file.
 
> Also, the manual just duplicates the doc string verbatim. Is there
> nothing else to say?

Not as far as I can tell.