From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.devel Subject: RE: Question about intended behavior of 'insert-for-yank-1'. Date: Mon, 12 Sep 2016 15:54:36 -0700 (PDT) Message-ID: <7abf7a00-3f17-4ef6-bfbd-0f5df4e7acd6@default> References: <874m5lr92d.fsf@red-bean.com> <83eg4p9hqk.fsf@gnu.org> <87inu1ghud.fsf@red-bean.com> <83y42x7yud.fsf@gnu.org> <87poo8g2zi.fsf@red-bean.com> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1473720906 8531 195.159.176.226 (12 Sep 2016 22:55:06 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 12 Sep 2016 22:55:06 +0000 (UTC) Cc: emacs-devel@gnu.org To: Karl Fogel , Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Sep 13 00:55:01 2016 Return-path: Envelope-to: ged-emacs-devel@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 1bja7s-00011H-07 for ged-emacs-devel@m.gmane.org; Tue, 13 Sep 2016 00:54:56 +0200 Original-Received: from localhost ([::1]:45542 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bja7q-00014l-1k for ged-emacs-devel@m.gmane.org; Mon, 12 Sep 2016 18:54:54 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:45608) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bja7j-00014V-TD for emacs-devel@gnu.org; Mon, 12 Sep 2016 18:54:48 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bja7h-0002Hl-Qv for emacs-devel@gnu.org; Mon, 12 Sep 2016 18:54:46 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:29352) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bja7c-0002GU-SL; Mon, 12 Sep 2016 18:54:41 -0400 Original-Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u8CMsdDu003676 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Mon, 12 Sep 2016 22:54:39 GMT Original-Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by userv0021.oracle.com (8.13.8/8.13.8) with ESMTP id u8CMsdjw001885 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Mon, 12 Sep 2016 22:54:39 GMT Original-Received: from abhmp0005.oracle.com (abhmp0005.oracle.com [141.146.116.11]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id u8CMscWw019504; Mon, 12 Sep 2016 22:54:38 GMT In-Reply-To: <87poo8g2zi.fsf@red-bean.com> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6753.5000 (x86)] X-Source-IP: userv0021.oracle.com [156.151.31.71] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-Received-From: 156.151.31.81 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:207404 Archived-At: > >> Thanks, Eli. Yes, that's true, but note that the doc string for > >> `insert-for-yank' just refers the reader to `insert-for-yank-1' for > >> details. The only doc string where the STRING-passing behavior is > >> discussed is the doc string of `insert-for-yank-1', and that doc > >> string indicates, or strongly implies, that the entirety of STRING > >> is passed (which it isn't). > > > >Ah, so this is about the doc string of insert-for-yank, not its > >subroutine. >=20 > I think that's fair, yes. It's about the combination of the two doc > strings: right now, the `insert-for-yank' doc string just refers the > reader to `insert-for-yank-1' for all the interesting stuff. If your > point is that solving this documentation bug involves changing the > documentation of `insert-for-yank' more than that of `insert-for-yank-1' > (and that the latter might not changing at all), that makes sense, and I > thank you for pointing out the real source of the problem. >=20 > >I agree that the doc string of insert-for-yank should describe what it > >does. What it says now hardly qualifies as documentation, and > >referring to an internal subroutine for that is, shall we say, > >suboptimal ;-) >=20 > Really, stepping back from the trees to see the forest, that should have > been my first reaction :-). >=20 > >Feel free to improve the doc string of insert-for-yank. >=20 > Will do. >=20 > While I don't see any outright errors in the doc string of `insert-for- > yank-1', IMHO it should more clearly document that STRING is the default > argument to FUNCTION, so I may also fix that. Bell ringing... http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D286