From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#21448: 25.0.50; `unicode-property-table-internal' in Elisp manual Date: Wed, 09 Sep 2015 22:10:49 +0300 Message-ID: <83io7j5rye.fsf@gnu.org> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1441825913 25993 80.91.229.3 (9 Sep 2015 19:11:53 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 9 Sep 2015 19:11:53 +0000 (UTC) Cc: 21448@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Sep 09 21:11:41 2015 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1ZZkmK-0004uY-RV for geb-bug-gnu-emacs@m.gmane.org; Wed, 09 Sep 2015 21:11:33 +0200 Original-Received: from localhost ([::1]:44788 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZZkmK-0007cq-KW for geb-bug-gnu-emacs@m.gmane.org; Wed, 09 Sep 2015 15:11:32 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:45666) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZZklv-00077y-DD for bug-gnu-emacs@gnu.org; Wed, 09 Sep 2015 15:11:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZZklr-00082P-5i for bug-gnu-emacs@gnu.org; Wed, 09 Sep 2015 15:11:07 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:33698) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZZklr-00082C-1C for bug-gnu-emacs@gnu.org; Wed, 09 Sep 2015 15:11:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1ZZklp-0006aH-Nl for bug-gnu-emacs@gnu.org; Wed, 09 Sep 2015 15:11:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 09 Sep 2015 19:11:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 21448 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 21448-submit@debbugs.gnu.org id=B21448.144182585925299 (code B ref 21448); Wed, 09 Sep 2015 19:11:01 +0000 Original-Received: (at 21448) by debbugs.gnu.org; 9 Sep 2015 19:10:59 +0000 Original-Received: from localhost ([127.0.0.1]:54141 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZZkln-0006Zz-4o for submit@debbugs.gnu.org; Wed, 09 Sep 2015 15:10:59 -0400 Original-Received: from mtaout20.012.net.il ([80.179.55.166]:60344) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZZkll-0006Zp-5z for 21448@debbugs.gnu.org; Wed, 09 Sep 2015 15:10:58 -0400 Original-Received: from conversion-daemon.a-mtaout20.012.net.il by a-mtaout20.012.net.il (HyperSendmail v2007.08) id <0NUF00C00BR1RJ00@a-mtaout20.012.net.il> for 21448@debbugs.gnu.org; Wed, 09 Sep 2015 22:10:55 +0300 (IDT) Original-Received: from HOME-C4E4A596F7 ([84.94.185.246]) by a-mtaout20.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0NUF00CPNBY7EO60@a-mtaout20.012.net.il>; Wed, 09 Sep 2015 22:10:55 +0300 (IDT) In-reply-to: X-012-Sender: halo1@inter.net.il X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x 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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:106323 Archived-At: > Date: Wed, 9 Sep 2015 07:57:13 -0700 (PDT) > From: Drew Adams > > 1. In node `Categories' you give an example that is incomprehensible, as > it uses function `unicode-property-table-internal', which is not > explained anywhere in the manual. With just the doc string of that > function to go on, it is difficult, if not impossible, to understand the > example. The doc string of unicode-property-table-internal says: (unicode-property-table-internal PROP) Return a char-table for Unicode character property PROP. What exactly is unclear about that? That's an honest question: this sounds crystal clear to me. > There is a cross-reference to node `Bidirectional Display', but that > node, although quite long (and with large, verbose paragraphs) does not > seem to help with understanding the example. It didn't help me, at > least. That cross-reference is for those who don't know what is "strong right-to-left directionality". > Please consider adding a little explanation of the example, including, > for instance, what table `uniprop-table' is being used for. It is used as an argument to map-char-table, as should be clear from the example. Once again, I don't see what should be explained about that. > Adding a docstring for the `defvar' would also help. This text before the example: Here's an example of defining a new category for characters that have strong right-to-left directionality is all that can be said about that defvar. > 2. The example also not indented properly - see the second `let' binding Fixed (someone left TABs in the Texinfo source, which is a no-no). > 3. Please consider also adding to the description of each of the > functions described in this node the statement that TABLE defaults to > the current buffer's category table - as opposed to having this > statement only in the sentence preceding the individual function > descriptions. I don't see why this should be an issue -- that sentence immediately precedes the description of the functions.