GNU bug report logs - #37141
ispell-skip-html is poorly documented, e.g. for XML

Previous Next

Package: emacs;

Reported by: Vincent Lefevre <vincent <at> vinc17.net>

Date: Thu, 22 Aug 2019 13:11:02 UTC

Severity: normal

Found in version 27.0.50

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


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

From: Vincent Lefevre <vincent <at> vinc17.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 37141 <at> debbugs.gnu.org
Subject: Re: bug#37141: 27.0.50; spelling doesn't work in XML comments
Date: Thu, 22 Aug 2019 16:29:42 +0200
On 2019-08-22 17:16:37 +0300, Eli Zaretskii wrote:
> > > That's a feature, see ispell-skip-html.
> > 
> > This is not documented in the Emacs manual.
> 
> We don't document every obscure feature in the manual, that would make
> it too large.  Some user options are left out.  I don't see why this
> one is important enough to add it, sorry.

That's not an obscure feature. The default is actually very silly.
There's no reason to exclude XML comments by default.

> > BTW, XML is not HTML.
> 
> Yes, and neither is SGML.  But a variable has a doc string, which is
> supposed to say more than just the name.

A user who does not know this variable and what it does will never
find it. Moreover, the doc string makes no sense. People should
learn how to write good documentation.

-- 
Vincent Lefèvre <vincent <at> vinc17.net> - Web: <https://www.vinc17.net/>
100% accessible validated (X)HTML - Blog: <https://www.vinc17.net/blog/>
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)




This bug report was last modified 5 years and 352 days ago.

Previous Next


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