GNU bug report logs - #46839
describe-variable should say something slightly different about invisibly defined variables

Previous Next

Package: emacs;

Reported by: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>

Date: Mon, 1 Mar 2021 03:26:01 UTC

Severity: normal

Tags: fixed

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 46839 in the body.
You can then email your comments to 46839 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#46839; Package emacs. (Mon, 01 Mar 2021 03:26:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 01 Mar 2021 03:26:02 GMT) Full text and rfc822 format available.

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

From: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
To: bug-gnu-emacs <at> gnu.org
Subject: describe-variable should say something slightly different about
 invisibly defined variables
Date: Sun, 28 Feb 2021 23:41:23 +0800
describe-variable says
  gnus-draft-setup-hook is a variable defined in ‘gnus-draft.el’.
  gnus-draft-mode-hook  is a variable defined in ‘gnus-draft.el’.

However one can be found in that file, one can't.

describe-variable could not be lying, therefore the one that can't be
found must still be declared, in some new invisible way. Fine.

However please make the help message output a little different,
so we will know if we are about to have a wild goose chase looking for
it or not.

"Well just click the link. If it is invisibly defined, you will just go
to the top of the file."

Yes, but still, please make the wording a little different:

E.g.,
  gnus-draft-setup-hook is a variable           defined in ‘gnus-draft.el’.
  gnus-draft-mode-hook  is a variable invisibly defined in ‘gnus-draft.el’.

(Proof:
$ zgrep gnus-draft-.*hook *.el.gz
gnus-draft.el.gz:(defcustom gnus-draft-setup-hook nil
gnus-draft.el.gz:    (run-hooks 'gnus-draft-setup-hook))))

OK. Now let's change some values and see what describe-variable says.

gnus-draft-mode-hook is a variable defined in ‘gnus-draft.el’.
Its value is ((lambda nil (goto-char (- (point-max) 1))))

gnus-draft-setup-hook is a variable defined in ‘gnus-draft.el’.
Its value is ((lambda nil (goto-char (- (point-max) 1))))
Original value was nil

gnus-summary-article-move-hook is a variable defined in ‘gnus-sum.el’.
Its value is nil

We can tell the second one, gnus-draft-setup-hook was chagnged by us,
because the Original value was mentioned.

But for the first and third, well one we tinkered with, and one we
didn't. But ah ha! There is no way to tell from the wording.

From the wording one guesses both still have the origninal value.

emacs-version "27.1"




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#46839; Package emacs. (Mon, 01 Mar 2021 13:04:01 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
Cc: 46839 <at> debbugs.gnu.org
Subject: Re: bug#46839: describe-variable should say something slightly
 different about invisibly defined variables
Date: Mon, 01 Mar 2021 14:03:17 +0100
積丹尼 Dan Jacobson <jidanni <at> jidanni.org> writes:

> describe-variable says
>   gnus-draft-setup-hook is a variable defined in ‘gnus-draft.el’.
>   gnus-draft-mode-hook  is a variable defined in ‘gnus-draft.el’.

[...]

> "Well just click the link. If it is invisibly defined, you will just go
> to the top of the file."

You've reported something like this before, and told that it's fixed in
Emacs 28.  

It's still fixed in Emacs 28.  You do not have to report this more
times.

Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 01 Mar 2021 13:04:01 GMT) Full text and rfc822 format available.

bug marked as fixed in version 28.1, send any further explanations to 46839 <at> debbugs.gnu.org and 積丹尼 Dan Jacobson <jidanni <at> jidanni.org> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 01 Mar 2021 13:04:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Tue, 30 Mar 2021 11:24:09 GMT) Full text and rfc822 format available.

This bug report was last modified 2 years and 364 days ago.

Previous Next


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