GNU bug report logs - #30707
describe-variable misses linking linkable changed items

Previous Next

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

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

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 misses linking linkable changed items
Date: Mon, 05 Mar 2018 10:17:57 +0800

I do
(describe-variable (quote browse-url-browser-function))
and see in *Help*:

   browse-url-browser-function is a variable defined in ‘browse-url.el’.
   Its value is ‘browse-url-chromium’
   Original value was
   browse-url-default-browser

The problem is browse-url-default-browser should be a blue link, but was
not detected as linkable.

So the user has to do
(describe-function (quote browse-url-default-browser))
to learn about it, instead of just being able to click it!

See, it really exists:
browse-url-default-browser is a compiled Lisp function in
‘browse-url.el’.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
Cc: 30707 <at> debbugs.gnu.org
Subject: Re: bug#30707: describe-variable misses linking linkable changed items
Date: Sun, 14 Jul 2019 16:28:36 +0200

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

> I do
> (describe-variable (quote browse-url-browser-function))
> and see in *Help*:
>
>    browse-url-browser-function is a variable defined in ‘browse-url.el’.
>    Its value is ‘browse-url-chromium’
>    Original value was
>    browse-url-default-browser
>
> The problem is browse-url-default-browser should be a blue link, but was
> not detected as linkable.
>
> So the user has to do
> (describe-function (quote browse-url-default-browser))
> to learn about it, instead of just being able to click it!

This sounds reasonable, but I don't think it is.  :-)
`browse-url-default-browser' is just a symbol that that variable had as
a value.  Yes, it's a symbol that refers to a function, but in general,
the doc machinery doesn't know that that's how it's going to be used; it
might be a total coincidence.  (Especially with shorter symbols.)

So I'm closing this bug report.

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

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

From: Noam Postavsky <npostavs <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 30707 <at> debbugs.gnu.org,
 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
Subject: Re: bug#30707: describe-variable misses linking linkable changed items
Date: Sun, 14 Jul 2019 10:56:15 -0400

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

> 積丹尼 Dan Jacobson <jidanni <at> jidanni.org> writes:
>
>>    browse-url-browser-function is a variable defined in ‘browse-url.el’.
>>    Its value is ‘browse-url-chromium’

>> The problem is browse-url-default-browser should be a blue link, but was
>> not detected as linkable.

> This sounds reasonable, but I don't think it is.  :-)
> `browse-url-default-browser' is just a symbol that that variable had as
> a value.  Yes, it's a symbol that refers to a function, but in general,
> the doc machinery doesn't know that that's how it's going to be used; it
> might be a total coincidence.  (Especially with shorter symbols.)

Even if it is just a coincidence, would it hurt to linkify it?

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 30707 <at> debbugs.gnu.org,
 積丹尼 Dan Jacobson <jidanni <at> jidanni.org>
Subject: Re: bug#30707: describe-variable misses linking linkable changed items
Date: Sun, 14 Jul 2019 17:03:45 +0200

Noam Postavsky <npostavs <at> gmail.com> writes:

> Even if it is just a coincidence, would it hurt to linkify it?

Yes, I think so.  It is confusing if you see a link, hit it, and it
takes you to someplace completely irrelevant.

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

Previous Next

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