* bug#31730: 26; doc string of `update-glyphless-char-display'
@ 2018-06-06 5:03 Drew Adams
2018-06-08 15:16 ` Eli Zaretskii
0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2018-06-06 5:03 UTC (permalink / raw)
To: 31730
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''
^ permalink raw reply [flat|nested] 2+ messages in thread
* bug#31730: 26; doc string of `update-glyphless-char-display'
2018-06-06 5:03 bug#31730: 26; doc string of `update-glyphless-char-display' Drew Adams
@ 2018-06-08 15:16 ` Eli Zaretskii
0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2018-06-08 15:16 UTC (permalink / raw)
To: Drew Adams; +Cc: 31730-done
> Date: Tue, 5 Jun 2018 22:03:07 -0700 (PDT)
> From: Drew Adams <drew.adams@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.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-06-08 15:16 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-06-06 5:03 bug#31730: 26; doc string of `update-glyphless-char-display' Drew Adams
2018-06-08 15:16 ` 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).