* bug#36647: 26.1; Please align examples of search-based fontification with recommendations
@ 2019-07-14 9:10 Markus Triska
2019-07-14 20:39 ` Glenn Morris
0 siblings, 1 reply; 3+ messages in thread
From: Markus Triska @ 2019-07-14 9:10 UTC (permalink / raw)
To: 36647
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#36647: 26.1; Please align examples of search-based fontification with recommendations
2019-07-14 9:10 bug#36647: 26.1; Please align examples of search-based fontification with recommendations Markus Triska
@ 2019-07-14 20:39 ` Glenn Morris
2019-07-17 11:02 ` Basil L. Contovounesios
0 siblings, 1 reply; 3+ messages in thread
From: Glenn Morris @ 2019-07-14 20:39 UTC (permalink / raw)
To: Markus Triska; +Cc: 36647
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.
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#36647: 26.1; Please align examples of search-based fontification with recommendations
2019-07-14 20:39 ` Glenn Morris
@ 2019-07-17 11:02 ` Basil L. Contovounesios
0 siblings, 0 replies; 3+ messages in thread
From: Basil L. Contovounesios @ 2019-07-17 11:02 UTC (permalink / raw)
To: Glenn Morris; +Cc: 36647-done, Markus Triska
tags 36647 notabug
close 36647
quit
Glenn Morris <rgm@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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-07-17 11:02 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-07-14 9:10 bug#36647: 26.1; Please align examples of search-based fontification with recommendations Markus Triska
2019-07-14 20:39 ` Glenn Morris
2019-07-17 11:02 ` Basil L. Contovounesios
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.