GNU bug report logs - #36883
Make Gnus documentation clearer ("dumbquotes")

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 36883 in the body.
You can then email your comments to 36883 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: Keith Thompson <Keith.S.Thompson <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Cc: Keith Thompson <Keith.S.Thompson <at> gmail.com>
Subject: Make Gnus documentation clearer ("dumbquotes")
Date: Wed, 31 Jul 2019 15:02:51 -0700

Emacs 26.2.90, Gnus v5.1

The Gnus info documentation includes the following:

‘W d’
     Treat M****s*** sm*rtq**t*s according to
     ‘gnus-article-dumbquotes-map’ (‘gnus-article-treat-dumbquotes’).
     Note that this function guesses whether a character is a sm*rtq**t*
     or not, so it should only be used interactively.

     Sm*rtq**t*s are M****s***’s unilateral extension to the character
     map in an attempt to provide more quoting characters.  If you see
     something like ‘\222’ or ‘\264’ where you’re expecting some kind of
     apostrophe or quotation mark, then try this wash.

I suggest changing "M****s***" to "Micrsoft" and "sm*rtq**t*s" to "smartquotes"
throughout.

I'd also suggest changing the command names "article-treat-dumbquotes"
and "gnus-article-treat-dumbquotes" to refer to "smartquotes" rather than
"dumbquotes", probably keeping the existing names as aliases.

IMHO documentation should make it easy to search without being
an obstacle to understanding. I don't object to snark, but it shoudn't
come at the expense of clarity.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Keith Thompson <Keith.S.Thompson <at> gmail.com>
Cc: 36883 <at> debbugs.gnu.org
Subject: Re: bug#36883: Make Gnus documentation clearer ("dumbquotes")
Date: Tue, 24 Sep 2019 00:43:11 +0200

Keith Thompson <Keith.S.Thompson <at> gmail.com> writes:

> I'd also suggest changing the command names "article-treat-dumbquotes"
> and "gnus-article-treat-dumbquotes" to refer to "smartquotes" rather than
> "dumbquotes", probably keeping the existing names as aliases.

I've now done so in Emacs 27.

-- 
(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.