GNU bug report logs - #12282
24.1.50; `font-lock-value-in-major-mode': doc string and parameter name

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 12282 in the body.
You can then email your comments to 12282 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: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.1.50;
	`font-lock-value-in-major-mode': doc string and parameter name
Date: Sun, 26 Aug 2012 07:59:36 -0700

The parameter should be renamed.  It is an alist associating major modes
with font-lock decoration levels OR it is such a level.
 
The current doc and parameter name give the impression that the argument
passed is typically an alist.  But in practice (existing code in Emacs
distribution, as well as existing 3rd-party code), it is more often a
decoration level (including `t' for max decoration) that is passed as
argument.
 
Just saying that the return value is ALIST if ALIST is not an alist,
while certainly correct, is being less clear than we could be.

In GNU Emacs 24.1.50.1 (i386-mingw-nt5.1.2600)
 of 2012-08-13 on MARVIN
Bzr revision: 109584 monnier <at> iro.umontreal.ca-20120813141247-76irjqslrfncn30u
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --no-opt --enable-checking --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include
 -ID:/devel/emacs/libs/libiconv-1.13.1-1-dev/include
 -ID:/devel/emacs/libs/libxml2-2.7.8/include/libxml2'
 

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 12282 <at> debbugs.gnu.org
Subject: Re: bug#12282: 24.1.50;
 `font-lock-value-in-major-mode': doc string and parameter name
Date: Sat, 08 Feb 2014 19:25:36 -0800

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

> The parameter should be renamed.  It is an alist associating major modes
> with font-lock decoration levels OR it is such a level.
>
> The current doc and parameter name give the impression that the argument
> passed is typically an alist.  But in practice (existing code in Emacs
> distribution, as well as existing 3rd-party code), it is more often a
> decoration level (including `t' for max decoration) that is passed as
> argument.
>
> Just saying that the return value is ALIST if ALIST is not an alist,
> while certainly correct, is being less clear than we could be.

Fixed on trunk.

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