bug#1660: 23.0.60; Wrong documentation for gnus-before-startup-hook

bug#1660: 23.0.60; Wrong documentation for gnus-before-startup-hook

[Leo]

Hi there,

(info "(gnus)Startup Variables")

`gnus-before-startup-hook'
     A hook run after starting up Gnus successfully.

while reading the Gnus manual today, I spotted this error. Please
correct it.

Cheers,

Leo

bug#1660: 23.0.60; Wrong documentation for gnus-before-startup-hook

[Stephen Berman]

On Sun, 21 Dec 2008 18:08:50 +0000 Leo <sdl.web@gmail.com> wrote:

> Hi there,
>
> (info "(gnus)Startup Variables")
>
> `gnus-before-startup-hook'
>      A hook run after starting up Gnus successfully.
>
> while reading the Gnus manual today, I spotted this error. Please
> correct it.

While you're at it, please also fix the doc string, which (in GNU Emacs
23.0.60.25 (i686-pc-linux-gnu, GTK+ Version 2.12.9) of 2008-12-18 on
escher) reads:

    gnus-before-startup-hook is a variable defined in `gnus-start.el'.
    Its value is nil

    Documentation:
    A hook called at before startup.
                  ^^^^^^^^^
    This hook is called as the first thing when Gnus is started.

Is it `at' or `before'?  The latter matches the variable's name, the
former seems to better reflect its semantics.  Maybe it should have been
called gnus-at-startup-hook or -- since there already is a
gnus-startup-hook, which runs after gnus-before-startup-hook -- even
more accurately gnus-before-startup-hook-hook :-)

Steve Berman

bug#1660: marked as done (23.0.60; Wrong documentation for gnus-before-startup-hook)

[Emacs bug Tracking System]

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


Your message dated Sun, 21 Dec 2008 20:41:17 +0100
with message-id <87skohe2oy.fsf@marauder.physik.uni-ulm.de>
and subject line Re: bug#1660: 23.0.60; Wrong documentation for gnus-before-startup-hook
has caused the Emacs bug report #1660,
regarding 23.0.60; Wrong documentation for gnus-before-startup-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 owner@emacsbugs.donarmstrong.com
immediately.)


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

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

From: Leo <sdl.web@gmail.com>
To: emacs-pretest-bug@gnu.org
Subject: 23.0.60; Wrong documentation for gnus-before-startup-hook
Date: Sun, 21 Dec 2008 18:08:50 +0000
Message-ID: <xbaivdtd8kp9.fsf@cam.ac.uk>

Hi there,

(info "(gnus)Startup Variables")

`gnus-before-startup-hook'
     A hook run after starting up Gnus successfully.

while reading the Gnus manual today, I spotted this error. Please
correct it.

Cheers,

Leo



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

From: Reiner Steib <reinersteib+gmane@imap.cc>
To: Leo <sdl.web@gmail.com>
Cc: 1660-done@emacsbugs.donarmstrong.com
Subject: Re: bug#1660: 23.0.60; Wrong documentation for gnus-before-startup-hook
Date: Sun, 21 Dec 2008 20:41:17 +0100
Message-ID: <87skohe2oy.fsf@marauder.physik.uni-ulm.de>

On Sun, Dec 21 2008, Leo wrote:

> (info "(gnus)Startup Variables")
>
> `gnus-before-startup-hook'
>      A hook run after starting up Gnus successfully.
>
> while reading the Gnus manual today, I spotted this error. Please
> correct it.

Fixed in Gnus CVS (will be synched to Emacs within a few day).
Thanks for your report.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

bug#1660: 23.0.60; Wrong documentation for gnus-before-startup-hook

[Reiner Steib]

[ Let's see if I can send to a closed bug ... ]

On Sun, Dec 21 2008, Stephen Berman wrote:

>     gnus-before-startup-hook is a variable defined in `gnus-start.el'.
>     Its value is nil
>
>     Documentation:
>     A hook called at before startup.
>                   ^^^^^^^^^
>     This hook is called as the first thing when Gnus is started.
>
> Is it `at' or `before'?  The latter matches the variable's name, the
> former seems to better reflect its semantics.  

I fixed it as follows:

--- gnus-start.el	15 Dec 2008 20:22:12 +0100	7.68
+++ gnus-start.el	21 Dec 2008 20:19:37 +0100	
@@ -392,7 +392,7 @@
   :type 'hook)
 
 (defcustom gnus-before-startup-hook nil
-  "A hook called at before startup.
+  "A hook called before startup.
 This hook is called as the first thing when Gnus is started."
   :group 'gnus-start
   :type 'hook)

> Maybe it should have been called gnus-at-startup-hook or -- since
> there already is a gnus-startup-hook, which runs after
> gnus-before-startup-hook -- even more accurately
> gnus-before-startup-hook-hook :-)

:-)

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/