GNU bug report logs - #36647
26.1; Please align examples of search-based fontification with recommendations

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 36647 in the body.
You can then email your comments to 36647 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: Markus Triska <triska <at> metalevel.at>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.1; Please align examples of search-based fontification with
 recommendations
Date: Sun, 14 Jul 2019 11:10:31 +0200

In 39.12.2 Defining Faces, the documentation of defface includes the text:

   "You should not quote the symbol FACE, and
    it should not end in ‘-face’ (that would be redundant)."

Yet, 23.6.2 Search-based Fontification repeatedly mentions fubar-face as
example face, and its name does end in -face:

    ;; Highlight occurrences of ‘fubar’,
    ;; using the face which is the value of ‘fubar-face’.
    ("fubar" . fubar-face)

The docstring of font-lock-keywords also repeatedly mentions fubar-face
as example:

    (\"fubar\" . fubar-face)
     Occurrences of \"fubar\" in the value of `fubar-face'.

To ensure exemplary face names and internal consistency of the manual,
it seems appropriate to change the example face names to names that are
in alignment with the manual's recommendations.

For instance, the cited examples could maybe be changed, respectively, to

    ;; Highlight occurrences of ‘fubar’,
    ;; using the face which is the value of ‘fubar’.
    ("fubar" . fubar)

and:

    (\"fubar\" . fubar)
     Occurrences of \"fubar\" in the value of the face `fubar'.

to follow the recommendations?

Thank you and all the best,
Markus


In GNU Emacs 26.1 (build 1, x86_64-apple-darwin15.3.0, X toolkit, Xaw scroll bars)
 of 2018-09-22 built on laptop
Windowing system distributor 'The X.Org Foundation', version 11.0.11502000

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

From: Glenn Morris <rgm <at> gnu.org>
To: Markus Triska <triska <at> metalevel.at>
Cc: 36647 <at> debbugs.gnu.org
Subject: Re: bug#36647: 26.1;
 Please align examples of search-based fontification with
 recommendations
Date: Sun, 14 Jul 2019 16:39:59 -0400

Markus Triska wrote:

> In 39.12.2 Defining Faces, the documentation of defface includes the text:
>
>    "You should not quote the symbol FACE, and
>     it should not end in '-face' (that would be redundant)."
>
> Yet, 23.6.2 Search-based Fontification repeatedly mentions fubar-face as
> example face, and its name does end in -face:
>
>     ;; Highlight occurrences of 'fubar',
>     ;; using the face which is the value of 'fubar-face'.
>     ("fubar" . fubar-face)

fubar-face is not a face, but a variable whose value is a face.
Thus, there is no inconsistency here.

Message #15 received at 36647-done <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 36647-done <at> debbugs.gnu.org, Markus Triska <triska <at> metalevel.at>
Subject: Re: bug#36647: 26.1; Please align examples of search-based
 fontification with recommendations
Date: Wed, 17 Jul 2019 12:02:12 +0100

tags 36647 notabug
close 36647
quit

Glenn Morris <rgm <at> gnu.org> writes:

> Markus Triska wrote:
>
>> In 39.12.2 Defining Faces, the documentation of defface includes the text:
>>
>>    "You should not quote the symbol FACE, and
>>     it should not end in '-face' (that would be redundant)."
>>
>> Yet, 23.6.2 Search-based Fontification repeatedly mentions fubar-face as
>> example face, and its name does end in -face:
>>
>>     ;; Highlight occurrences of 'fubar',
>>     ;; using the face which is the value of 'fubar-face'.
>>     ("fubar" . fubar-face)
>
> fubar-face is not a face, but a variable whose value is a face.
> Thus, there is no inconsistency here.

Indeed, as the line immediately preceding the citation explains:

‘(MATCHER . FACESPEC)’
     In this kind of element, FACESPEC is an expression whose value
     specifies the face to use for highlighting.  In the simplest case,
     FACESPEC is a Lisp variable (a symbol) whose value is a face name.

So I'm closing this report.

Thanks,

-- 
Basil

Previous Next

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