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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#31730: closed (26; doc string of `update-glyphless-char-display')
Date: Fri, 08 Jun 2018 15:18:01 +0000

[Message part 1 (text/plain, inline)]

Your message dated Fri, 08 Jun 2018 18:16:50 +0300
with message-id <8336xxux3x.fsf <at> gnu.org>
and subject line Re: bug#31730: 26; doc string of `update-glyphless-char-display'
has caused the debbugs.gnu.org bug report #31730,
regarding 26; doc string of `update-glyphless-char-display'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
31730: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=31730
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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 part 3 (message/rfc822, inline)]

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.