GNU bug report logs - #44202
[PATCH] Add variable to control confirmation of help-mode-revert-buffer

Previous Next

Full log

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Kevin Foley <kevin <at> kevinjfoley.me>, 44202 <at> debbugs.gnu.org
Subject: RE: bug#44202: [PATCH] Add variable to control confirmation of
 help-mode-revert-buffer
Date: Sat, 24 Oct 2020 16:40:39 -0700 (PDT)

> +(defcustom help-mode-revert-buffer-noconfirm nil
> +  "Indicates whether to prompt for confirmation when reverting a
> +help buffer."

A minor comment (and others may disagree with me).

I think the first line of the doc string should
say what a true value means, because the option
name does that.

Or at least the doc string should somehow make
clear which Boolean value means which behavior.

E.g.:

Non-nil means do not prompt for confirmation when reverting a help buffer.

If you just say "whether" there's no way to know
which value means what, except to guess from the
option name, in which case the doc string doesn't
add anything.

Previous Next

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