GNU bug report logs - #46926
Remove the quotes from highlighted/linked symbols when displaying docs

Previous Next

Full log

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: scame <laszlomail <at> protonmail.com>
Cc: stefan <at> marxist.se, larsi <at> gnus.org, 46926 <at> debbugs.gnu.org, rms <at> gnu.org
Subject: Re: bug#46926: Remove the quotes from highlighted/linked symbols when
 displaying docs
Date: Sat, 13 Mar 2021 09:43:29 +0200

> Cc: "46926 <at> debbugs.gnu.org" <46926 <at> debbugs.gnu.org>,
>  "larsi <at> gnus.org" <larsi <at> gnus.org>, Stefan Kangas <stefan <at> marxist.se>
> Date: Sat, 13 Mar 2021 06:08:31 +0000
> From:  scame via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> >
> > The purpose of quotes in Texinfo output is to make semantic
> > distinctions. In other words, to show what kind of role that text
> > plays in the program being documented.
> 
> In the main body of the Help text only symbols are linked AFAIK. Is
> that right?
> 
> So the quotes don't convey any extra meaning and the symbols are linked,
> so they can be clicked to instantly see their documentation. The quotes
> are just extra noise in the rendered output, breaking the visual flow of
> the text unnecessarily.

Help buffers are not directly related to Texinfo.  However, we had
already some complaints in the past about the differences between
those two, so I think it would make sense not to make them diverge any
further.

Your opinion that the quotes are visual noise is noted (you expressed
it several times already), but it doesn't mean we must accept it.

Since the quotes are present in the original doc strings (and will
stay there, for sure), the implementation of your proposal would be to
remove them when we generate the "buttons" (a.k.a. "links") for them
in the Help buffer.  So, if people feel that removing the quotes could
be desired by some users, how about making it optional, by default
off?

Previous Next

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