GNU bug report logs - #15906
24.3.50; Rename `highlight-*' functions

Previous Next

Full log

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.3.50; Rename `highlight-*' functions
Date: Fri, 15 Nov 2013 10:31:24 -0800 (PST)

The prefix `highlight-' should not be used for something as specific as
`hi-lock' highlighting or highlighting to show changes.  There are lots
of different kinds of highlighting in Emacs.  And third party libraries
provide many more ways.  The latter are requested by convention to use a
library prefix.

Hi Lock is one kind of highlighting, and quite particular.  The "lock"
part of its name is significant - it differentiates this highlighting
from other highlighting, and it should be present in the function names.

These are the functions to rename, with suggested renamings:

highlight-lines-matching-regexp    -> hi-lock-lines-matching-regexp
highlight-phrase                   -> hi-lock-phrase
highlight-regexp                   -> hi-lock-regexp
highlight-changes-mode             -> hilit-changes-mode
highlight-changes-next-change      -> hilit-changes-next-change
highlight-changes-previous-change  -> hilit-changes-previous-change
highlight-changes-remove-highlight -> hilit-changes-remove-highlight
highlight-changes-rotate-faces     -> hilit-changes-rotate-faces
highlight-changes-visible-mode     -> hilit-changes-visible-mode
highlight-compare-buffers          -> hilit-compare-buffers
highlight-compare-with-file        -> hilit-compare-with-file

An alternative for the `hilit-' functions would be to use `changes-' as
the prefix.  The result is clearer and shorter names, and it puts up
front what the highlighting is about: showing changes:

changes-highlight-mode
changes-highlight-next
changes-highlight-previous
changes-remove-highlight
changes-rotate-faces
changes-visible-mode
changes-compare-buffers
changes-compare-with-file

(No need for "highlight" at all in half of these names.)


In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-11-12 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'

Previous Next

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