From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#18089: 24.4.50; doc string of `delete-selection-helper' Date: Sat, 30 Apr 2016 00:36:35 +0200 Message-ID: <8737q4m498.fsf@gnus.org> References: <0ef5fe9b-00d1-4005-b3bf-22df85779287@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461969463 26195 80.91.229.3 (29 Apr 2016 22:37:43 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 29 Apr 2016 22:37:43 +0000 (UTC) Cc: 18089@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 00:37:31 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1awH2Q-0007t0-RN for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 00:37:30 +0200 Original-Received: from localhost ([::1]:56640 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awH2M-0002DM-WE for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Apr 2016 18:37:27 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:55088) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awH2C-0001yc-S6 for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:37:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awH21-0006gx-5i for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:37:11 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:43784) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awH21-0006ef-2p for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:37:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awH1x-0008Vx-L5 for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:37:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 29 Apr 2016 22:37:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 18089 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 18089-submit@debbugs.gnu.org id=B18089.146196940132682 (code B ref 18089); Fri, 29 Apr 2016 22:37:01 +0000 Original-Received: (at 18089) by debbugs.gnu.org; 29 Apr 2016 22:36:41 +0000 Original-Received: from localhost ([127.0.0.1]:56118 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awH1d-0008V4-01 for submit@debbugs.gnu.org; Fri, 29 Apr 2016 18:36:41 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:51609) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awH1a-0008Uw-Mg for 18089@debbugs.gnu.org; Fri, 29 Apr 2016 18:36:39 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awH1Y-0003pn-4K; Sat, 30 Apr 2016 00:36:38 +0200 In-Reply-To: <0ef5fe9b-00d1-4005-b3bf-22df85779287@default> (Drew Adams's message of "Wed, 23 Jul 2014 09:45:32 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) 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:117285 Archived-At: Drew Adams writes: > 1. Mention of the TYPE value `t' is incorrrect. It should be "non-nil", > everywhere, based on what the code actually does (and has always done). Ok; fixed. > 2. For FUNCTION, it is not true that the return value should be "one of > the above values" (even if non-nil replaces t). The return value can > apparently also be another FUNCTION. So the doc string for FUNCTION > should say that the return value of FUNCTION should be a value > acceptable as TYPE. Ditto. > 3. All of the info in this doc string should be in the doc string of > `delete-selection-pre-hook', not in the "helper" function. Perhaps... but it has a link to the helper function, and I think it's nice that the helper function has this documentation. So no. > 4. Doc string lines should be no wider than 70 columns (except the > first). Fixed. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no