From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#31730: 26; doc string of `update-glyphless-char-display' Date: Fri, 08 Jun 2018 18:16:50 +0300 Message-ID: <8336xxux3x.fsf@gnu.org> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1528470971 24280 195.159.176.226 (8 Jun 2018 15:16:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 8 Jun 2018 15:16:11 +0000 (UTC) Cc: 31730-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jun 08 17:16:07 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fRJ7W-0006DD-TI for geb-bug-gnu-emacs@m.gmane.org; Fri, 08 Jun 2018 17:16:07 +0200 Original-Received: from localhost ([::1]:36526 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fRJ9d-0005EQ-RR for geb-bug-gnu-emacs@m.gmane.org; Fri, 08 Jun 2018 11:18:17 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:39677) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fRJ9S-0005Cl-0p for bug-gnu-emacs@gnu.org; Fri, 08 Jun 2018 11:18:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fRJ9O-0002gh-12 for bug-gnu-emacs@gnu.org; Fri, 08 Jun 2018 11:18:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:60168) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fRJ9N-0002gb-TY for bug-gnu-emacs@gnu.org; Fri, 08 Jun 2018 11:18:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fRJ9N-0007cG-Oc for bug-gnu-emacs@gnu.org; Fri, 08 Jun 2018 11:18:01 -0400 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Fri, 08 Jun 2018 15:18:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 31730 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Mail-Followup-To: 31730@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 31730-done@debbugs.gnu.org id=D31730.152847102429205 (code D ref 31730); Fri, 08 Jun 2018 15:18:01 +0000 Original-Received: (at 31730-done) by debbugs.gnu.org; 8 Jun 2018 15:17:04 +0000 Original-Received: from localhost ([127.0.0.1]:39831 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fRJ8S-0007az-EU for submit@debbugs.gnu.org; Fri, 08 Jun 2018 11:17:04 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:48465) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fRJ8P-0007aS-Ow for 31730-done@debbugs.gnu.org; Fri, 08 Jun 2018 11:17:02 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fRJ8G-0002Ck-Oo for 31730-done@debbugs.gnu.org; Fri, 08 Jun 2018 11:16:56 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:59514) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fRJ8G-0002Cc-KZ; Fri, 08 Jun 2018 11:16:52 -0400 Original-Received: from [176.228.60.248] (port=1637 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1fRJ8F-0007rZ-M9; Fri, 08 Jun 2018 11:16:52 -0400 In-reply-to: (message from Drew Adams on Tue, 5 Jun 2018 22:03:07 -0700 (PDT)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:147179 Archived-At: > Date: Tue, 5 Jun 2018 22:03:07 -0700 (PDT) > From: Drew Adams > > 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.