From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Stephen Berman Newsgroups: gmane.emacs.bugs Subject: bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation Date: Fri, 19 May 2017 15:30:14 +0200 Message-ID: <87vaoxoty1.fsf@rosalinde> References: <93AB3C85-27C1-48FF-8C3D-B90B4CF33670@gmail.com> <83o9up2hli.fsf@gnu.org> <7F0AE9BE-93FF-4CF7-8F76-AE1BD0CFDDDC@gmail.com> <83inkx2eeu.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1495200692 13531 195.159.176.226 (19 May 2017 13:31:32 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 19 May 2017 13:31:32 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.50 (gnu/linux) Cc: 26925@debbugs.gnu.org, Jean-Christophe Helary To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri May 19 15:31:27 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 1dBi07-0003Mr-2P for geb-bug-gnu-emacs@m.gmane.org; Fri, 19 May 2017 15:31:27 +0200 Original-Received: from localhost ([::1]:58808 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dBi0C-0008FI-Gr for geb-bug-gnu-emacs@m.gmane.org; Fri, 19 May 2017 09:31:32 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:55974) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dBhzm-000855-CJ for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 09:31:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dBhzj-00007v-An for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 09:31:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:51898) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dBhzj-00007h-65 for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 09:31:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dBhzi-0001lZ-QX for bug-gnu-emacs@gnu.org; Fri, 19 May 2017 09:31:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stephen Berman Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 19 May 2017 13:31: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.14952006286745 (code B ref 26925); Fri, 19 May 2017 13:31:02 +0000 Original-Received: (at 26925) by debbugs.gnu.org; 19 May 2017 13:30:28 +0000 Original-Received: from localhost ([127.0.0.1]:54575 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dBhz9-0001ki-Tu for submit@debbugs.gnu.org; Fri, 19 May 2017 09:30:28 -0400 Original-Received: from mout.gmx.net ([212.227.17.20]:65352) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dBhz7-0001kU-KT for 26925@debbugs.gnu.org; Fri, 19 May 2017 09:30:26 -0400 Original-Received: from rosalinde ([83.135.4.92]) by mail.gmx.com (mrgmx101 [212.227.17.168]) with ESMTPSA (Nemesis) id 0Mchyv-1dTVoh2893-00Hwi6; Fri, 19 May 2017 15:30:18 +0200 In-Reply-To: <83inkx2eeu.fsf@gnu.org> (Eli Zaretskii's message of "Fri, 19 May 2017 15:56:41 +0300") X-Provags-ID: V03:K0:dDIQ5ew9C3cfnUH0MfVdhB8TeFECzfQvKe1LyxBNVLqRLZuzckQ u8JVQthTiohT9CbN4S7JHhkeEsHr2AKfE2TEXw0xwXaqhGBbkR2BiGdrKGQTIhDzohSu1oO mQMCs3NwUYTF3xDN1Z0iIO9M9OdqxQO2gpjYzTntgVwHbhTY4EzMXovwwVeg3uKGcxSQvz6 GGLno7ENiZIZvP/4uh9WQ== X-UI-Out-Filterresults: notjunk:1;V01:K0:hADgVOBjOrQ=:Xrswq6BQ87vAq6ZdRlzl2w qFEuabo2YKeTJKVuGxZn9bYILZJtw2RJMncz9pvHqeZ2NZeZujoOgTAy/vHwmhYgQ0eVn+uho b0U+jF1XRY6p35pMkpduosT6mPdQRwffp+REp3wQalVWDLC7bvDY8rSRElkkdxr3lHqST4J3r lQqdaZ4VSlUYJ26UNjBODh1WnbKSETVwSWCD9LltkxYnGujFKshm9V54yPvlyxK1ssF1Vf5qw zML1D4bFhlMR2AzuXyKQPPSoHxzYP3AdnlaK3ijxk15ipvQKdGoj9KjTTNxiz00JXQNn37ncx LUfb8Um8IlcPj1h0n2fpsF/hKx/j4GIw6q4zGCkdHZpctRE6eOnntcUVonGyM2xp8jdRMH1Mt LgsPUijOgVYYfK7EaAEZ2dPIccdpHsYwYPP2ciMmSmmTzjl/e0py3ShwO44rg2pdFid8XOrGd OGw2MHnzinosI3JWo8JgN0HP2GRguyVp8MTqpOC3u0UX9zkflQuXrMUCRqn0siCS+fV1hji/Q E1xHKqfxXiR4ozepuA0h7Q0IPlaNJ9dlUJuXuL5aXiJHwLyt7H/8/u8i2JGNE07l1P5NmfZ/A wextERhVoa8ZJ1gFTGmnWzoUw02jAYvEedPuPI3z+npdGI1OBG08mJwXeq+Vs8cGRP7xjz/wE iUrt2mWwFgXt95TvTeWBRYjbFdL0CqrcqY4zqnXwpggYAy/UqVzC5CLBualE6ktCvO3sfzqqg Fmlj4+apbCSeg2V0WLN0vheq08/9rlf24w5gzJ+BaXdjS71zLekgZQobHnmw8VigwXzVspV7 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:132640 Archived-At: 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