From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Jean-Christophe Helary Newsgroups: gmane.emacs.bugs Subject: bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation Date: Sat, 3 Jun 2017 17:50:27 +0900 Message-ID: <3D9A3600-CF3D-4DD9-866C-CBEE8F692B25@gmail.com> References: <93AB3C85-27C1-48FF-8C3D-B90B4CF33670@gmail.com> <83o9up2hli.fsf@gnu.org> <7F0AE9BE-93FF-4CF7-8F76-AE1BD0CFDDDC@gmail.com> <83inkx2eeu.fsf@gnu.org> <87vaoxoty1.fsf@rosalinde> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\)) Content-Type: multipart/mixed; boundary="Apple-Mail=_5C0BBB9F-0704-4EDF-A7D7-F161F9C93E00" X-Trace: blaine.gmane.org 1496479872 9384 195.159.176.226 (3 Jun 2017 08:51:12 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 3 Jun 2017 08:51:12 +0000 (UTC) Cc: 26925@debbugs.gnu.org To: Stephen Berman Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Jun 03 10:51:07 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 1dH4m2-0002A6-Vl for geb-bug-gnu-emacs@m.gmane.org; Sat, 03 Jun 2017 10:51:07 +0200 Original-Received: from localhost ([::1]:52965 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dH4m8-0002rs-D8 for geb-bug-gnu-emacs@m.gmane.org; Sat, 03 Jun 2017 04:51:12 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:55710) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dH4m1-0002rj-Hp for bug-gnu-emacs@gnu.org; Sat, 03 Jun 2017 04:51:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dH4ly-00038P-F2 for bug-gnu-emacs@gnu.org; Sat, 03 Jun 2017 04:51:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:49711) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dH4ly-00036f-AN for bug-gnu-emacs@gnu.org; Sat, 03 Jun 2017 04:51:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dH4lx-0005Jh-T6 for bug-gnu-emacs@gnu.org; Sat, 03 Jun 2017 04:51:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Jean-Christophe Helary Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 03 Jun 2017 08:51:01 +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.149647983920410 (code B ref 26925); Sat, 03 Jun 2017 08:51:01 +0000 Original-Received: (at 26925) by debbugs.gnu.org; 3 Jun 2017 08:50:39 +0000 Original-Received: from localhost ([127.0.0.1]:52388 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dH4lb-0005J7-CL for submit@debbugs.gnu.org; Sat, 03 Jun 2017 04:50:39 -0400 Original-Received: from mail-pf0-f171.google.com ([209.85.192.171]:33201) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dH4lZ-0005Iv-6M for 26925@debbugs.gnu.org; Sat, 03 Jun 2017 04:50:37 -0400 Original-Received: by mail-pf0-f171.google.com with SMTP id 83so4179924pfr.0 for <26925@debbugs.gnu.org>; Sat, 03 Jun 2017 01:50:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:message-id:mime-version:subject:date:in-reply-to:cc:to :references; bh=xCUISPG4XsDD50gqfmBkq2Eit7RPUwtHf/yNW5MAOYY=; b=mzAH61YjioGoGTnTsPnj2CuoNWcrhFNIOGE7zJ3XrgGRU+CNo+HjNd9LxBb8ZzPoLZ P09fQH5O0YE+zSJyODjRNq3/j6scz89zHhO29g70OpUf7mSu6o36pjr+2S2OWke2vp56 nng0FvgypTZaf/yoOBUa+dY/m9fySXTFqi45RMNqScihwkjMFn7ll4Kbwg6Rb2tfDxT4 4IRZUcKwEe4eSGo81VDjkWQWEOeXt2NlWTHkchIheiVzgRS3SR5dVtjWLCaSy+nC3p+P tQQQZCr9ndM6ILvaptoSj0c7QKFm24UW+GTA/7/pJdRwLOzFK/aLW//ad6DsKHnx6XG9 pAOg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:message-id:mime-version:subject:date :in-reply-to:cc:to:references; bh=xCUISPG4XsDD50gqfmBkq2Eit7RPUwtHf/yNW5MAOYY=; b=hLBkwzAmoLQnzFan37dA1RVarmjmI4SncJdE1+vi9alb2e43VEbg0lfaCz9us0Z56t 45NGazE9jmhM5vXGQH6cqdhcnHQakKYJ1+fkN/507h/ggUy06jyJZk9/KQFzRkQLWolv 82PzP5tcM+/gIPpvIjEuq/xjVZyKfSh9fr6xfUow2pZUZmG7Xek+GFPprE/HWpQRKKRe LhSJuCLQ4HroUiP8DE/500vgdnwW3XF/7i6ZZe7Gd0uRSBFwigEetoiaXcNSkNwfw2Kg jAwR5gRn9LRpS94yIjZneZ4XSq/dBUDgDL3nsoQTDPMxFdnwHrUuNQV89NRdOG3YCiqU RDxA== X-Gm-Message-State: AODbwcBdYHtouB6XbDSjX9Cka/qliWtgmTI/yZhrQooOmWt+QIjaio1U pQl+ads/pmvf0g== X-Received: by 10.84.213.8 with SMTP id f8mr4157068pli.22.1496479831270; Sat, 03 Jun 2017 01:50:31 -0700 (PDT) Original-Received: from [192.168.24.63] (pl25298.ag0304.nttpc.ne.jp. [133.232.153.210]) by smtp.gmail.com with ESMTPSA id l88sm14212775pfg.23.2017.06.03.01.50.29 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sat, 03 Jun 2017 01:50:30 -0700 (PDT) In-Reply-To: <87vaoxoty1.fsf@rosalinde> X-Mailer: Apple Mail (2.3273) 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:133211 Archived-At: --Apple-Mail=_5C0BBB9F-0704-4EDF-A7D7-F161F9C93E00 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 Just one tiny bit of cleanup: -If the optional argument @var{trim} =E2=86=92 +If @var{trim} just to adapt the text to the description of the other arguments. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D Improve documentation of 'split-string' * doc/lispref/strings.texi (Creating Strings): Correct a wording in = `split-string'. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D --Apple-Mail=_5C0BBB9F-0704-4EDF-A7D7-F161F9C93E00 Content-Disposition: attachment; filename=strings.texi.diff Content-Type: application/octet-stream; x-unix-mode=0644; name="strings.texi.diff" Content-Transfer-Encoding: 7bit diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi index e80e778bec..b500b3d355 100644 --- a/doc/lispref/strings.texi +++ b/doc/lispref/strings.texi @@ -289,10 +289,9 @@ null strings whenever there are two consecutive matches for @var{string}. If @var{omit-nulls} is @code{t}, these null strings are omitted from the result. -If the optional argument @var{trim} is non-@code{nil}, it should be a -regular expression to match text to trim from the beginning and end of -each substring. If trimming makes the substring empty, it is treated -as null. +If @var{trim} is non-@code{nil}, it should be a regular expression to +match text to trim from the beginning and end of each substring. If +trimming makes the substring empty, it is treated as null. If you need to split a string into a list of individual command-line arguments suitable for @code{call-process} or @code{start-process}, --Apple-Mail=_5C0BBB9F-0704-4EDF-A7D7-F161F9C93E00 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset=us-ascii > On 2017/05/19, at 22:30, Stephen Berman wrote: > > On Fri, 19 May 2017 15:56:41 +0300 Eli Zaretskii wrote: > >>> 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. > > Yes for code ChangeLogs, but for the Texinfo sources, the convention for > ChangeLog entries seems to be to put the node name in parentheses, and > then the function name would be quoted in the entry, as usual, e.g.: > > * doc/lispref/strings.texi (Creating Strings): Change paragraph > order of `split-string' definition to improve readability. > > This convention of putting the node name in parens is apparently > undocumented, but it's what `C-x 4 a' does and (probably that's why) > almost all the ChangeLog entries for the Texinfo sources follow it. > > Steve Berman --Apple-Mail=_5C0BBB9F-0704-4EDF-A7D7-F161F9C93E00--