GNU bug report logs - #55086
28.1; Improve doc of set-fontset-font

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 55086 in the body.
You can then email your comments to 55086 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: Howard Melman <hmelman <at> gmail.com>
To: GNU Emacs <bug-gnu-emacs <at> gnu.org>
Subject: 28.1; Improve doc of set-fontset-font
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)

Howard

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Howard Melman <hmelman <at> gmail.com>, "55086 <at> debbugs.gnu.org"
 <55086 <at> debbugs.gnu.org>
Subject: RE: [External] : bug#55086: 28.1; Improve doc of set-fontset-font
Date: Sat, 23 Apr 2022 22:07:38 +0000

> 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.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Howard Melman <hmelman <at> gmail.com>
Cc: 55086-done <at> debbugs.gnu.org
Subject: Re: bug#55086: 28.1; Improve doc of set-fontset-font
Date: Sun, 24 Apr 2022 09:57:27 +0300

> From: Howard Melman <hmelman <at> 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.

Previous Next

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