unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Reza Nikoopour <rnikoopour@gmail.com>
Cc: 47105@debbugs.gnu.org
Subject: bug#47105: defface docs
Date: Fri, 12 Mar 2021 20:32:04 +0200	[thread overview]
Message-ID: <83v99wjk9n.fsf@gnu.org> (raw)
In-Reply-To: <CAKesZq1tK4VXtkzT-EFLRyjNTsYA-jORdJNvnNmeqsUdFXCabg@mail.gmail.com> (message from Reza Nikoopour on Fri, 12 Mar 2021 08:53:18 -0800)

> From: Reza Nikoopour <rnikoopour@gmail.com>
> Date: Fri, 12 Mar 2021 08:53:18 -0800
> 
>  People are sometimes tempted to create a variable whose value is a face name. In the vast majority of
>  cases, this is not necessary; the usual procedure is to define a face with defface, and then use its
>  name directly. 
> 
>  You should not quote the symbol face, and it should not end in ‘-face’ (that would be redundant).
> 
> I see both of these conventions in font-lock.el. 
> 
> https://github.com/emacs-mirror/emacs/blob/master/lisp/font-lock.el#L318-L319
> https://github.com/emacs-mirror/emacs/blob/master/lisp/font-lock.el#L1976-L1979
> 
> Could the docs be updated to reflect what's happening in font-lock.el?  I'd be happy to make the contribution,
> but I don't know the proper way to suggest an update to the manual.
> 
> Alternatively, could it be explained why font-lock.el doesn't follow these conventions?

It's the case of "do as I say, not as I do".  We cannot always follow
our own recommendations for some historical reasons.






  parent reply	other threads:[~2021-03-12 18:32 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-12 16:53 bug#47105: defface docs Reza Nikoopour
2021-03-12 18:08 ` Lars Ingebrigtsen
2021-03-12 18:32 ` Eli Zaretskii [this message]
2021-03-18  7:07   ` 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=83v99wjk9n.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=47105@debbugs.gnu.org \
    --cc=rnikoopour@gmail.com \
    /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).