GNU bug report logs - #60587
30.0.50; Info pages are lacking links from symbol names to the symbol's help documentation

Previous Next

Full log

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

From: "H. Dieter Wilhelm" <dieter <at> duenenhof-wilhelm.de>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>,
 "60587 <at> debbugs.gnu.org" <60587 <at> debbugs.gnu.org>,
 "monnier <at> iro.umontreal.ca" <monnier <at> iro.umontreal.ca>
Subject: Re: [External] : bug#60587: Patch for adding links to symbols' help
 documentation
Date: Wed, 01 Feb 2023 23:09:54 +0100

Hi Drew

Drew Adams <drew.adams <at> oracle.com> writes:

>> > 1.
>> > +  :type '(choice (const :tag "Create links" t)
>> > +                 (const :tag "Do not link" nil))
>> >
>> > is better as just :type 'boolean, and say in the
>> > doc which Boolean value means which behavior.
>> 
>> The doc string says now:
>> 
>>   "True (`t') means Emacs creates symbol link buttons in Info.
>> Setting this variable to `nil' inhibits the creation of buttons
>> on quoted symbols to their help strings.  Please see the function
>> `info-make-xrefs' for further details."
>
> Is the defcustom now :type 'boolean?

Please tell me why you insist now on changing the :type from choice to
boolean?  Above you stated that it "is better than just :type boolean"!?

I experimented in `customize' with :type 'boolean and the "toggle"
button is fast and easy.  On the other hand with 'choice I think the
alternatives are clearer documented while changing it's values..

>> > 4. Or instead of having an option, maybe just have
>> > a minor mode.
>> 
>> That's also a nice idea.  (Maybe for later.)
>
> See Stefan's reply...

Alright, I'm going in this direction but I'm not so fast.  😅

>> > 6. "clicking @kbd{mouse-2} or @kbd{mouse-1} on it"
>> > can't be right, I think.  At least that doesn't
>> > express what `mouse-1-follows-link' does/means.

On the suggestion of Eli, I just stated `mouse' and added a cross
reference, ahem, link to the mouse manual section.

Thanks for your interest

       Dieter
-- 
Best wishes
H. Dieter Wilhelm
Zwingenberg, Germany

Previous Next

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