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: Sun, 4 Jun 2017 18:19:45 +0900 Message-ID: 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> <3D9A3600-CF3D-4DD9-866C-CBEE8F692B25@gmail.com> <83o9u5bde1.fsf@gnu.org> <12A8E2CE-F2F5-4DB9-88DE-BCD40513EEBA@gmail.com> <83h8zxb02p.fsf@gnu.org> <98B33B3E-AB18-4BDB-A012-5270F3FCD7C2@gmail.com> <83bmq4bhpv.fsf@gnu.org> <87efv09oqj.fsf@detlef> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\)) Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1496568021 27159 195.159.176.226 (4 Jun 2017 09:20:21 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sun, 4 Jun 2017 09:20:21 +0000 (UTC) Cc: 26925@debbugs.gnu.org, stephen.berman@gmx.net To: Michael Albinus Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Jun 04 11:20:15 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 1dHRhl-0006bq-9E for geb-bug-gnu-emacs@m.gmane.org; Sun, 04 Jun 2017 11:20:13 +0200 Original-Received: from localhost ([::1]:56272 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dHRhq-0003Xb-Nv for geb-bug-gnu-emacs@m.gmane.org; Sun, 04 Jun 2017 05:20:18 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50373) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dHRhe-0003P9-Cy for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 05:20:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dHRha-0001Pz-6o for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 05:20:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:51908) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dHRha-0001Pv-2g for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 05:20:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dHRhZ-00059J-Nn for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 05:20: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: Sun, 04 Jun 2017 09:20: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.149656799419774 (code B ref 26925); Sun, 04 Jun 2017 09:20:01 +0000 Original-Received: (at 26925) by debbugs.gnu.org; 4 Jun 2017 09:19:54 +0000 Original-Received: from localhost ([127.0.0.1]:54585 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dHRhS-00058s-G7 for submit@debbugs.gnu.org; Sun, 04 Jun 2017 05:19:54 -0400 Original-Received: from mail-pf0-f193.google.com ([209.85.192.193]:35214) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dHRhQ-00058e-59 for 26925@debbugs.gnu.org; Sun, 04 Jun 2017 05:19:52 -0400 Original-Received: by mail-pf0-f193.google.com with SMTP id u26so17377240pfd.2 for <26925@debbugs.gnu.org>; Sun, 04 Jun 2017 02:19:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=sSkOfhqenxqHcLto5n5APvUst80VUlTJuap/yHBUjhI=; b=E6WvmI6RZJrTvXiV82TA3Fe6IDCq6ONKvLIXeZbryeuCyGCVsNJR3wwz6u/8YYdduq VM8J0k9JW5/zFFeWW1+8+Kuj6uYPIVdWgSUYvgiYGmUrm3h6Kgojzrxyp6i/Yv0w8VVb xGQVgJcl24CSqxiac1DOKEkQckpwdNKiSWnVcfnhSuB10YPzSc8JJVgu54ry9iE6r6x/ jDuICKbpTyBZdXEYlOnEmCN4YVz22KT4qOxt2RrNAzro00DTEzb3kLNB9SXoVKszxqk4 Rb7/J9qCtidZwnNsfgACIOh7RxQqpV8qK4M7VdL8wQ2adkbo2NWP0GAwb/fi0jMbKwZ1 GKoA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=sSkOfhqenxqHcLto5n5APvUst80VUlTJuap/yHBUjhI=; b=csH2zOgvai1vhibYsc6lTntU600u99MOivEk4Joghh4u5Qqz45iEtdrc6kUvCRtM2T sIoRBXjby+h5DZV6qwWHPFb/LJya+18OVQ6p9+gUCtBHBXocmD2Nuvl+1iVOlqlP2uYH wPj/MAp9/q1JkXqOMS/DpOVYx2RfAy9t120nNRgjfReoxQq2qpKaVFlWoZBJMXveu6US S0fDF3mcMx5N599g0fPR8glNLWqXgJEbReFfAX/26dpqdHTovLMQPYWUwefnpUR5HyRi CRqCOGeizXp6JYEVRAC5BFp1jzWHoBe1Ilg1SLQcdFlxSAKLG6DIF6pMd86Xzyg4bElS +/bA== X-Gm-Message-State: AODbwcBZCCkwo/CDt6/5HKJyPZz3Yx6t8VauFQrEgoxZU631tX5yD5Ui U4jPERtUkvXTDA== X-Received: by 10.84.174.197 with SMTP id r63mr8848857plb.36.1496567986164; Sun, 04 Jun 2017 02:19:46 -0700 (PDT) Original-Received: from [192.168.22.136] (p5037-ipbffx02kyoto.kyoto.ocn.ne.jp. [61.214.117.37]) by smtp.gmail.com with ESMTPSA id d185sm42075655pgc.39.2017.06.04.02.19.44 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 04 Jun 2017 02:19:45 -0700 (PDT) In-Reply-To: <87efv09oqj.fsf@detlef> 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:133246 Archived-At: > On 2017/06/04, at 16:49, Michael Albinus = wrote: >=20 > Eli Zaretskii writes: >=20 > Hi Eli, >=20 >>>>> It's up to you. I thought it was weird that all the other >>>> optional arguments were not labeled as "optional" and only this >>>> one. >>>>=20 >>>> That's not what I see: grepping the ELisp manual for "optional >>>> argument" comes up with more than 200 hits. It's quite normal to = use >>>> that. >>>=20 >>> I am talking about this function. This function does not use >>> "optional arguments" for its other optional arguments. >>=20 >> Sorry, but I don't see that as a significant evidence. There's >> nothing special about this function that would cause us to treat it >> any different from the rest. >>=20 >> Once again, these are matters of personal style, and IMO we shouldn't >> make changes motivated by style preferences alone. >=20 > I don't believe Jean-Christophe is speaking about his personal style. = He > claims that two different personal styles are used in the = `split-string' > description in the lispref manual: SEPARATORS and OMIT-NULLS are > described as arguments, and TRIM is described as "optional argument" > explicitely. He proposes to harmonize this, which I support. That's correct. Sorry if my wording made that unclear. > And btw, the docstring of `split-string' does not speak about TRIM as > "optional argument" either. Indeed. When I modified the documentation the other day I just copy-pasted the = trim documentation from the *end* of the function documentation (after = the examples) to its beginning (following the other arguments = description *before* the examples) and missed that lack of = harmonization. That's something I should have fixed then. Sorry for = that. Jean-Christophe=