GNU bug report logs - #31730
26; doc string of `update-glyphless-char-display'

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 31730 in the body.
You can then email your comments to 31730 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: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26; doc string of `update-glyphless-char-display'
Date: Tue, 5 Jun 2018 22:03:07 -0700 (PDT)

The doc string is not understandable (to me).

1. For starters, neither of the functions parameters is described.
This is the main problem with this doc.

2. And it's not clear what "making the setting" of a variable "take
effect" even means.  Some help in this regard comes from the doc string
of `glyphless-char-display-control', but the statement about making the
setting of the variable take effect could be made more clear.  If the
value is only set effectively by the options's :set function, then just
say, in the doc string of `update-glyphless-char-display', that it is
the :set function for option `glyphless-char-display'.



In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-05-30
Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 31730-done <at> debbugs.gnu.org
Subject: Re: bug#31730: 26; doc string of `update-glyphless-char-display'
Date: Fri, 08 Jun 2018 18:16:50 +0300

> Date: Tue, 5 Jun 2018 22:03:07 -0700 (PDT)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> The doc string is not understandable (to me).
> 
> 1. For starters, neither of the functions parameters is described.
> This is the main problem with this doc.
> 
> 2. And it's not clear what "making the setting" of a variable "take
> effect" even means.  Some help in this regard comes from the doc string
> of `glyphless-char-display-control', but the statement about making the
> setting of the variable take effect could be made more clear.  If the
> value is only set effectively by the options's :set function, then just
> say, in the doc string of `update-glyphless-char-display', that it is
> the :set function for option `glyphless-char-display'.

Yes, this function is the setter for glyphless-char-display, and I
made the change you suggested.

Thanks.

Previous Next

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