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: Mon, 5 Jun 2017 14:15:55 +0900 Message-ID: <8EB2DE67-3233-4E0F-9AAB-6CE34885536A@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> <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> <83a85nc0tu.fsf@gnu.org> <5D1082E3-48E6-4A39-B831-55BA992C7CC9@gmail.com> <8337bfbvs0.fsf@gnu.org> <83r2yz9mnb.fsf@gnu.org> 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 1496639832 20231 195.159.176.226 (5 Jun 2017 05:17:12 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 5 Jun 2017 05:17:12 +0000 (UTC) Cc: 26925@debbugs.gnu.org, stephen.berman@gmx.net, michael.albinus@gmx.de To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jun 05 07:17:08 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 1dHkO3-00050F-KC for geb-bug-gnu-emacs@m.gmane.org; Mon, 05 Jun 2017 07:17:07 +0200 Original-Received: from localhost ([::1]:59644 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dHkO8-0007WP-Un for geb-bug-gnu-emacs@m.gmane.org; Mon, 05 Jun 2017 01:17:12 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:37288) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dHkO2-0007W8-Mc for bug-gnu-emacs@gnu.org; Mon, 05 Jun 2017 01:17:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dHkNy-00020I-3S for bug-gnu-emacs@gnu.org; Mon, 05 Jun 2017 01:17:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:53709) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dHkNx-0001zv-WE for bug-gnu-emacs@gnu.org; Mon, 05 Jun 2017 01:17:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dHkNx-0007ZM-LH for bug-gnu-emacs@gnu.org; Mon, 05 Jun 2017 01:17: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: Mon, 05 Jun 2017 05:17: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.149663976729033 (code B ref 26925); Mon, 05 Jun 2017 05:17:01 +0000 Original-Received: (at 26925) by debbugs.gnu.org; 5 Jun 2017 05:16:07 +0000 Original-Received: from localhost ([127.0.0.1]:56386 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dHkN5-0007YD-G6 for submit@debbugs.gnu.org; Mon, 05 Jun 2017 01:16:07 -0400 Original-Received: from mail-pf0-f195.google.com ([209.85.192.195]:34540) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dHkN2-0007XS-RH for 26925@debbugs.gnu.org; Mon, 05 Jun 2017 01:16:05 -0400 Original-Received: by mail-pf0-f195.google.com with SMTP id w69so19414123pfk.1 for <26925@debbugs.gnu.org>; Sun, 04 Jun 2017 22:16:04 -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=u4zzOf2jBaBUY0uF8IrQhRuBMUIb32DLqFxlEYzX3kw=; b=a8QC9FtW/2XOybqlorMt0336y8J26q63wlwbqKXtKMirn7dIxuVL9Sx0OVcxBBRzIR Y65lbob3+KnvrL9t1MvT/kughiP0eFmI15D7OcSs4VVH+hS4VRT5/iaIRK/OtZaLzzre fOKXCT45Nchcz1BMAITZObFLgW45LT4uj8MKrU/ELJ3fV0wuZniZozuh5ZlftrLLJtcW 50GIEh8LII555JZnKOpZkfpcD9vnavLajc5IjeDKB/I0siO5He9vnup+YMnxX+Hg5QRr YDJbOFARH1tR4xoLyNVSosH/R8XmaZReZyqKwxr9NIGNosLtphR4PyTZkg2TJ09LCZgy uQ3Q== 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=u4zzOf2jBaBUY0uF8IrQhRuBMUIb32DLqFxlEYzX3kw=; b=gpyyernfjya4EzYwXh8fSkyX7htWSUeK4d5fZWM09lvDPEk+xsiluOMBpjMn+/cVn5 QLq70OIspXI7gEBZRNHs8Fh+pVY7NRoFjLZy7pS+L86ymHZnR3bmWASUSO1T8PDl+lkh RJ4N7tsok8U+TXGrpR/Q46+sCdnH/WJbDcgFxN2jNkzNipgHn80g0gmSHay0SfjGjho6 +QVrRz5mnSx/glTBxgCaL+onAk2jhVcAYeF3x+Vx8iIWhxvD6xFI2ujd722VwfXWmtbk gyWjHtq6Kv4436k5i+OoGgkeYTMmIgSaHRyzkow5TRyLqRZa8hGpdiCbBGiKqQa99G18 QegQ== X-Gm-Message-State: AODbwcAeyUCvGECl11vBVRFn4tk3iEjQzQba34ZTxihcAYs/0LJ+zgu/ g2kuVBROx/nHdQ== X-Received: by 10.98.36.72 with SMTP id r69mr12445174pfj.86.1496639759041; Sun, 04 Jun 2017 22:15:59 -0700 (PDT) Original-Received: from [192.168.24.55] (pl2587.ag0304.nttpc.ne.jp. [128.53.196.27]) by smtp.gmail.com with ESMTPSA id g20sm54070928pfk.21.2017.06.04.22.15.56 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 04 Jun 2017 22:15:58 -0700 (PDT) In-Reply-To: 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:133280 Archived-At: >>> Does that mean that you suggest we explicitly declare them optional = in split-string ? >>=20 >> Yes, I think so. >=20 > Ok, I'll do it. I've checked subr.el and the only functions that specifically document = an argument as optional in the doc string are: alist-get suppress-keymap substitute-key-definition add-hook remove-hook add-to-list (only 1 out of 2) add-to-ordered-list add-to-history add-minor-mode locate-library (2/3) process-kill-without-query read-passwd read-char-choice sit-for momentary-string-display sha1 (2/3) match-substitute-replacement subst-char-in-string replace-regexp-in-string define-mail-user-agent set-transient-map make-progress-reporter (3/5) out of 52 defuns (and 2 defsubst) that use &optional. Should we modify all the remaining docstrings so that they explicitly = specify when an argument is optional? Jean-Christophe=20=