GNU bug report logs - #36448
26.2; doc string of `highlight-lines-matching-regexp'

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Drew Adams <drew.adams <at> oracle.com>
Subject: bug#36448: closed (Re: bug#36448: 26.2; doc string of
 `highlight-lines-matching-regexp')
Date: Wed, 03 Jul 2019 12:57:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#36448: 26.2; doc string of `highlight-lines-matching-regexp'

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 36448 <at> debbugs.gnu.org.

-- 
36448: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=36448
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 36448-done <at> debbugs.gnu.org
Subject: Re: bug#36448: 26.2; doc string of `highlight-lines-matching-regexp'
Date: Wed, 03 Jul 2019 15:56:14 +0300

> Date: Sun, 30 Jun 2019 13:40:10 -0700 (PDT)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> This part of the doc string is not so good:
> 
>   Set face of all lines containing a match of REGEXP to FACE.
> 
> That's not what happens - "set" is the wrong verb here (face attributes
> are set, but not the displayed face as a whole).

Thanks, fixed.

[Message part 3 (message/rfc822, inline)]

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.2; doc string of `highlight-lines-matching-regexp'
Date: Sun, 30 Jun 2019 13:40:10 -0700 (PDT)

This part of the doc string is not so good:

  Set face of all lines containing a match of REGEXP to FACE.

That's not what happens - "set" is the wrong verb here (face attributes
are set, but not the displayed face as a whole).

For example, if `font-lock-mode' is enabled and the command highlights a
line that contains text already highlighted by font-lock (e.g. with a
face foreground attribute) then the `highlight-lines-matching-regexp'
highlighting adds its face to the `face' spec for that already
highlighted text.  It does not replace face attributes that are already
set there.

The doc string should just say something similar to what (elisp)
`Highlight Interactively' says:

  Highlight entire lines containing a match for REGEXP, using face
  FACE ('highlight-lines-matching-regexp').

Highlighting "using" FACE is less definitive (more vague) than "setting"
the face to FACE.

If the doc string wants to go into more detail then it can say that FACE
is _added_ to faces already present, or that its attributes are added
merged with those already present.




In GNU Emacs 26.2 (build 1, x86_64-w64-mingw32)
 of 2019-04-13
Repository revision: fd1b34bfba8f3f6298df47c8e10b61530426f749
Windowing system distributor `Microsoft Corp.', version 10.0.17134
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

Previous Next

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