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#26925: Improve /doc/lispref/strings.texi (split-string) documentation Date: Fri, 19 May 2017 15:56:41 +0300 Message-ID: <83inkx2eeu.fsf@gnu.org> References: <93AB3C85-27C1-48FF-8C3D-B90B4CF33670@gmail.com> <83o9up2hli.fsf@gnu.org> <7F0AE9BE-93FF-4CF7-8F76-AE1BD0CFDDDC@gmail.com> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1495198698 4617 195.159.176.226 (19 May 2017 12:58:18 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 19 May 2017 12:58:18 +0000 (UTC) Cc: 26925@debbugs.gnu.org To: Jean-Christophe Helary Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri May 19 14:58:14 2017 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 1dBhTw-00015S-51 for geb-bug-gnu-emacs@m.gmane.org; Fri, 19 May 2017 14:58:12 +0200 Original-Received: from localhost ([::1]:58677 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dBhU1-0000NV-OX for geb-bug-gnu-emacs@m.gmane.org; Fri, 19 May 2017 08:58:17 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:49717) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dBhTt-0000Ll-Mh for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 08:58:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dBhTm-0007zz-Qn for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 08:58:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:51884) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dBhTm-0007zv-O6 for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 08:58:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dBhTm-0000zd-HX for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 08:58: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: Fri, 19 May 2017 12:58:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 26925 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 26925-submit@debbugs.gnu.org id=B26925.14951986243731 (code B ref 26925); Fri, 19 May 2017 12:58:02 +0000 Original-Received: (at 26925) by debbugs.gnu.org; 19 May 2017 12:57:04 +0000 Original-Received: from localhost ([127.0.0.1]:54551 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dBhSp-0000y6-ML for submit@debbugs.gnu.org; Fri, 19 May 2017 08:57:03 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:58330) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dBhSn-0000xb-Mh for 26925@debbugs.gnu.org; Fri, 19 May 2017 08:57:01 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dBhSd-0007W1-Ie for 26925@debbugs.gnu.org; Fri, 19 May 2017 08:56:56 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:56176) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dBhSd-0007Vx-FL; Fri, 19 May 2017 08:56:51 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:3720 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1dBhSc-0004es-NN; Fri, 19 May 2017 08:56:51 -0400 In-reply-to: <7F0AE9BE-93FF-4CF7-8F76-AE1BD0CFDDDC@gmail.com> (message from Jean-Christophe Helary on Fri, 19 May 2017 21:23:57 +0900) 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:132638 Archived-At: > From: Jean-Christophe Helary > Date: Fri, 19 May 2017 21:23:57 +0900 > Cc: 26925-done@debbugs.gnu.org > > > One nit: please don't refer to functions with syntax that looks like a > > function call, as in (split-string) above, or foo() for C sources. > > The GNU Coding Standards frown on such references, because they look > > like a call to a function with no arguments, which is not what is > > meant there. We use 'split-string' and 'foo' instead, i.e. the name > > of the function in quotes. > > Thank you Eli. > > So the function name should have been quoted in both occurrences? > > >> =========================== > >> Improve documentation of 'split-string' > >> > >> * /doc/lispref/strings.texi 'split-string': change paragraph > >> order to improve readability. > >> =========================== No, only in the first occurrence. In the ChangeLog-style entries, we always put function names in parentheses.