* bug#55086: 28.1; Improve doc of set-fontset-font
@ 2022-04-23 21:51 Howard Melman
2022-04-23 22:07 ` Drew Adams
2022-04-24 6:57 ` Eli Zaretskii
0 siblings, 2 replies; 3+ messages in thread
From: Howard Melman @ 2022-04-23 21:51 UTC (permalink / raw)
To: 55086
The eldoc string for set-fontset-font in Emacs 28 is
(NAME TARGET FONT-SPEC &optional FRAME ADD)
I found NAME and TARGET to be unhelpfully generic. The
docstring does say that name is the name of a fontset and
that TARGET is about characters.
The elisp manual names the params as:
Function: set-fontset-font name character font-spec &optional frame add
character is an improvement but it should be plural.
I think they should be the same in both places and
this would be clearer:
(FONTSET CHARACTERS FONT-SPEC &optional FRAME ADD)
Howard
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#55086: 28.1; Improve doc of set-fontset-font
2022-04-23 21:51 bug#55086: 28.1; Improve doc of set-fontset-font Howard Melman
@ 2022-04-23 22:07 ` Drew Adams
2022-04-24 6:57 ` Eli Zaretskii
1 sibling, 0 replies; 3+ messages in thread
From: Drew Adams @ 2022-04-23 22:07 UTC (permalink / raw)
To: Howard Melman, 55086@debbugs.gnu.org
> The eldoc string for set-fontset-font in Emacs 28 is
>
> (NAME TARGET FONT-SPEC &optional FRAME ADD)
>
> I found NAME and TARGET to be unhelpfully generic. The
> docstring does say that name is the name of a fontset and
> that TARGET is about characters.
>
> The elisp manual names the params as:
>
> set-fontset-font name character font-spec &optional frame add
>
> character is an improvement but it should be plural.
>
> I think they should be the same in both places and
> this would be clearer:
>
> (FONTSET CHARACTERS FONT-SPEC &optional FRAME ADD)
+1 for that renaming. (It's also OK to use just CHARS.)
The first doc line also doesn't really respect the
convention of describing args in order. (Not a biggee,
IMO.) That could maybe be remedied also - perhaps
something like this (67 chars):
Modify FONTSET for use on CHARACTERS so that it respects FONT-SPEC.
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#55086: 28.1; Improve doc of set-fontset-font
2022-04-23 21:51 bug#55086: 28.1; Improve doc of set-fontset-font Howard Melman
2022-04-23 22:07 ` Drew Adams
@ 2022-04-24 6:57 ` Eli Zaretskii
1 sibling, 0 replies; 3+ messages in thread
From: Eli Zaretskii @ 2022-04-24 6:57 UTC (permalink / raw)
To: Howard Melman; +Cc: 55086-done
> From: Howard Melman <hmelman@gmail.com>
> Date: Sat, 23 Apr 2022 17:51:21 -0400
>
> The eldoc string for set-fontset-font in Emacs 28 is
>
> (NAME TARGET FONT-SPEC &optional FRAME ADD)
>
> I found NAME and TARGET to be unhelpfully generic. The
> docstring does say that name is the name of a fontset and
> that TARGET is about characters.
>
> The elisp manual names the params as:
>
> Function: set-fontset-font name character font-spec &optional frame add
>
> character is an improvement but it should be plural.
>
> I think they should be the same in both places and
> this would be clearer:
>
> (FONTSET CHARACTERS FONT-SPEC &optional FRAME ADD)
Thanks, done.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-04-24 6:57 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-04-23 21:51 bug#55086: 28.1; Improve doc of set-fontset-font Howard Melman
2022-04-23 22:07 ` Drew Adams
2022-04-24 6:57 ` Eli Zaretskii
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).