bug#41322: [PATCH] Remove reference to missing gnus-custom-mode-hook

bug#41322: [PATCH] Remove reference to missing gnus-custom-mode-hook

[Stefan Kangas]

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

There is a reference to `gnus-custom-mode-hook' in the docstring of
`gnus-custom-mode'.  However, I can't find this hook variable anywhere
in the sources and it is not used as advertised in `gnus-custom-mode'.

Should this reference just be removed, like in the attached patch?

Best regards,
Stefan Kangas

[-- Attachment #2: 0001-lisp-gnus-gnus-cus.el-gnus-custom-mode-Doc-fix.patch --]
[-- Type: text/x-diff, Size: 1000 bytes --]

From 0ccf4ab71ebace40158075f8ba06ae2ce09c31fb Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Sat, 16 May 2020 15:24:13 +0200
Subject: [PATCH] * lisp/gnus/gnus-cus.el (gnus-custom-mode): Doc fix.

---
 lisp/gnus/gnus-cus.el | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/lisp/gnus/gnus-cus.el b/lisp/gnus/gnus-cus.el
index f0c4d07ca9..7c647f7f78 100644
--- a/lisp/gnus/gnus-cus.el
+++ b/lisp/gnus/gnus-cus.el
@@ -41,10 +41,7 @@ gnus-custom-mode
 \\[widget-forward]		Move to next button or editable field.
 \\[widget-backward]		Move to previous button or editable field.
 \\[widget-button-click]		Activate button under the mouse pointer.
-\\[widget-button-press]		Activate button under point.
-
-Entry to this mode calls the value of `gnus-custom-mode-hook'
-if that value is non-nil."
+\\[widget-button-press]		Activate button under point."
   (use-local-map widget-keymap)
   ;; Emacs stuff:
   (when (and (facep 'custom-button-face)
-- 
2.26.2

bug#41322: [PATCH] Remove reference to missing gnus-custom-mode-hook

[Eric Abrahamsen]

Stefan Kangas <stefankangas@gmail.com> writes:

> There is a reference to `gnus-custom-mode-hook' in the docstring of
> `gnus-custom-mode'.  However, I can't find this hook variable anywhere
> in the sources and it is not used as advertised in `gnus-custom-mode'.

It's just an automatically-generated mode hook, like all the others, it
doesn't need to be referenced in gnus-cus.el code.

C-h v gnus-custom-mode-hook

gnus-custom-mode-hook is a variable defined in ‘gnus-cus.el’.
Its value is nil

  This variable may be risky if used as a file-local variable.

Documentation:
Hook run after entering Gnus Customize mode.
No problems result if this variable is not bound.
‘add-hook’ automatically binds it.  (This is true for all hook variables.)

bug#41322: [PATCH] Remove reference to missing gnus-custom-mode-hook

[Stefan Kangas]

tags 41322 + notabug
close 41322
thanks

Eric Abrahamsen <eric@ericabrahamsen.net> writes:

> It's just an automatically-generated mode hook, like all the others, it
> doesn't need to be referenced in gnus-cus.el code.

Ah, but of course.  Sorry about the brain fart.

Best regards,
Stefan Kangas