From: Drew Adams <drew.adams@oracle.com>
To: 15906@debbugs.gnu.org
Subject: bug#15906: 24.3.50; Rename `highlight-*' functions
Date: Fri, 15 Nov 2013 10:31:24 -0800 (PST) [thread overview]
Message-ID: <24a86bb5-f82f-4211-b0a7-dc40ddd60470@default> (raw)
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'
next reply other threads:[~2013-11-15 18:31 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-11-15 18:31 Drew Adams [this message]
2016-04-29 14:08 ` bug#15906: 24.3.50; Rename `highlight-*' functions Lars Ingebrigtsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=24a86bb5-f82f-4211-b0a7-dc40ddd60470@default \
--to=drew.adams@oracle.com \
--cc=15906@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).