From: Gregory Heytings <gregory@heytings.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 57499-done@debbugs.gnu.org
Subject: bug#57499: Documentation bug in the docstring of set-face-attribute?
Date: Thu, 01 Sep 2022 09:02:50 +0000 [thread overview]
Message-ID: <f61b9c2619cf124f06f2@heytings.org> (raw)
In-Reply-To: <834jxrscu7.fsf@gnu.org>
>> So this call is already included in the previous one. Why should we
>> tell users to add such a redundant call in their code?
>
> The new text doesn't say the call with FRAME = t should be an additional
> call.
>
It doesn't say so explicitly indeed, but without reading the code of
set-face-attribute everyone understands that it should be an additional
call.
>> As far as I understand, the actual and real problem here is some users
>> use nil when they should use 'unspecified, because they are not aware
>> that nil and 'unspecified are subtly different. The subtle difference
>> is that using nil works for frame = #<frame-1> ... #<frame-n>, but does
>> not work with frame = t.
>
> That is a backward-compatibility feature that I don't want to mention in
> the doc string. Lisp programs should only use valid values that are
> documented in the doc string.
>
I wasn't suggesting to mention this. I was suggesting to add a mention
that the symbol 'unspecified should be used for the value `unspecified',
which might be clear to you and me but is evidently not clear for users.
>
> I've installed the last text I proposed, and I'm closing this bug with
> that.
>
Would the patch below be okay? This would be another way to clarify the
matter.
diff --git a/src/xfaces.c b/src/xfaces.c
index 70d5cbeb4c..2dfba51f74 100644
--- a/src/xfaces.c
+++ b/src/xfaces.c
@@ -3390,6 +3390,8 @@ DEFUN ("internal-set-lisp-face-attribute",
Finternal_set_lisp_face_attribute,
}
else if (EQ (attr, QCforeground))
{
+ if (NILP (value) && EQ (frame, Qt))
+ signal_error ("Invalid foreground face attribute value", value);
/* Compatibility with 20.x. */
if (NILP (value))
value = Qunspecified;
@@ -3410,6 +3412,8 @@ DEFUN ("internal-set-lisp-face-attribute",
Finternal_set_lisp_face_attribute,
else if (EQ (attr, QCdistant_foreground))
{
/* Compatibility with 20.x. */
+ if (NILP (value) && EQ (frame, Qt))
+ signal_error ("Invalid distant-foreground face attribute value", value);
if (NILP (value))
value = Qunspecified;
if (!UNSPECIFIEDP (value)
@@ -3428,6 +3432,8 @@ DEFUN ("internal-set-lisp-face-attribute",
Finternal_set_lisp_face_attribute,
}
else if (EQ (attr, QCbackground))
{
+ if (NILP (value) && EQ (frame, Qt))
+ signal_error ("Invalid background face attribute value", value);
/* Compatibility with 20.x. */
if (NILP (value))
value = Qunspecified;
next prev parent reply other threads:[~2022-09-01 9:02 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-31 8:14 bug#57499: Documentation bug in the docstring of set-face-attribute? Gregory Heytings
2022-08-31 8:17 ` Gregory Heytings
2022-08-31 11:11 ` Eli Zaretskii
2022-08-31 12:04 ` Gregory Heytings
2022-08-31 12:39 ` Eli Zaretskii
2022-08-31 12:53 ` Gregory Heytings
2022-08-31 13:06 ` Eli Zaretskii
2022-08-31 13:43 ` Gregory Heytings
2022-08-31 16:11 ` Eli Zaretskii
2022-08-31 18:33 ` Gregory Heytings
2022-08-31 19:13 ` Eli Zaretskii
2022-08-31 19:33 ` Gregory Heytings
2022-08-31 19:49 ` Eli Zaretskii
2022-08-31 21:13 ` Gregory Heytings
2022-09-01 7:04 ` Eli Zaretskii
2022-09-01 8:25 ` Gregory Heytings
2022-09-01 8:44 ` Eli Zaretskii
2022-09-01 9:02 ` Gregory Heytings [this message]
2022-09-01 11:33 ` Eli Zaretskii
2022-09-01 11:56 ` Gregory Heytings
2022-09-01 12:08 ` Eli Zaretskii
2022-09-01 13:15 ` Gregory Heytings
2022-09-01 14:56 ` Eli Zaretskii
2022-09-01 17:07 ` Gregory Heytings
2022-09-01 18:24 ` Eli Zaretskii
2022-09-01 19:35 ` Gregory Heytings
2022-09-02 16:00 ` Eli Zaretskii
2022-09-02 20:48 ` Gregory Heytings
2022-09-03 6:00 ` Eli Zaretskii
2022-09-03 6:43 ` Gregory Heytings
2022-09-03 1:26 ` Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors
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=f61b9c2619cf124f06f2@heytings.org \
--to=gregory@heytings.org \
--cc=57499-done@debbugs.gnu.org \
--cc=eliz@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).