GNU bug report logs - #19483
25.0.50; out-of-date doc and Commentary in `font-lock' wrt `font-lock-syntactic-keywords'

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Thu, 1 Jan 2015 22:26:01 UTC

Severity: minor

Tags: notabug

Found in version 25.0.50

Done: Stefan Monnier <monnier <at> iro.umontreal.ca>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 19483-done <at> debbugs.gnu.org
Subject: bug#19483: 25.0.50; out-of-date doc and Commentary in `font-lock' wrt `font-lock-syntactic-keywords'
Date: Fri, 2 Jan 2015 23:59:54 -0800 (PST)
> tags 19483 notabug
> thanks
> 
> > `C-h v font-lock-syntactic-keywords' says that the variable is
> > obsolete since 24.1.
> 
> That's right.
> 
> > But in font-lock.el, the code, multiple doc strings, and
> > the Commentary all rely on it.
> 
> No, they just keep supporting it, because it's only "obsolete" and
> not "removed".

The doc and Commentary should reflect the fact that it has been
declared "obsolete".  That's the point.

> Do you really want to advocate we remove features right away when we
> decide they're obsolete?

Strawman, again.  No one suggested that you remove any feature.

Read the bug report.  It's about the doc (including Commentary). 

When you deprecate something, the doc for it should state that it
is deprecated.  Everywhere.

That the doc was not brought up to date about this as soon as
the status changed to deprecated was a doc bug 4 releases ago.
The bug is still there.

Emacs is the self-documenting editor.  It should tell users
about itself accurately.




This bug report was last modified 10 years and 202 days ago.

Previous Next


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