Subject: bug#31730: closed (Re: bug#31730: 26; doc string of `update-glyphless-char-display')

From: [email-masked] (GNU bug Tracking System)
Date: Fri, 08 Jun 2018 15:18:01 +0000

Your bug report

#31730: 26; doc string of `update-glyphless-char-display'

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
31730: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=31730
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#31730: 26; doc string of `update-glyphless-char-display'
From: Eli Zaretskii <[email-masked]>
To: Drew Adams <[email-masked]>
Cc: [email-masked]
Date: Fri, 08 Jun 2018 18:16:50 +0300
List-Id: <debbugs-submit.debbugs.gnu.org>

> Date: Tue, 5 Jun 2018 22:03:07 -0700 (PDT)
> From: Drew Adams <[email-masked]>
> 
> 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.

Subject: 26; doc string of `update-glyphless-char-display'
From: Drew Adams <[email-masked]>
To: [email-masked]
Date: Tue, 5 Jun 2018 22:03:07 -0700 (PDT)
List-Id: <debbugs-submit.debbugs.gnu.org>

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