GNU bug report logs - #18192
Incorrect implication in delete-{backward,forward}-char docstrings

Message received at submit <at> debbugs.gnu.org:

Received: (at submit) by debbugs.gnu.org; 4 Aug 2014 18:33:38 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Aug 04 14:33:38 2014
Received: from localhost ([127.0.0.1]:57557 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.80)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1XEN4j-00024G-Nc
	for submit <at> debbugs.gnu.org; Mon, 04 Aug 2014 14:33:38 -0400
Received: from eggs.gnu.org ([208.118.235.92]:32946)
 by debbugs.gnu.org with esmtp (Exim 4.80)
 (envelope-from <rrt@HIDDEN>) id 1XEN4h-00023z-J6
 for submit <at> debbugs.gnu.org; Mon, 04 Aug 2014 14:33:36 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <rrt@HIDDEN>) id 1XEN4b-00050u-Bc
 for submit <at> debbugs.gnu.org; Mon, 04 Aug 2014 14:33:30 -0400
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org
X-Spam-Level: 
X-Spam-Status: No, score=0.0 required=5.0 tests=BAYES_40,HTML_MESSAGE,
 T_DKIM_INVALID autolearn=disabled version=3.3.2
Received: from lists.gnu.org ([2001:4830:134:3::11]:33420)
 by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <rrt@HIDDEN>)
 id 1XEN4b-00050n-8H
 for submit <at> debbugs.gnu.org; Mon, 04 Aug 2014 14:33:29 -0400
Received: from eggs.gnu.org ([2001:4830:134:3::10]:34661)
 by lists.gnu.org with esmtp (Exim 4.71)
 (envelope-from <rrt@HIDDEN>) id 1XEN4a-0000Ql-0I
 for bug-gnu-emacs@HIDDEN; Mon, 04 Aug 2014 14:33:29 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <rrt@HIDDEN>) id 1XEN4V-0004xk-13
 for bug-gnu-emacs@HIDDEN; Mon, 04 Aug 2014 14:33:27 -0400
Received: from fencepost.gnu.org ([2001:4830:134:3::e]:44297)
 by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <rrt@HIDDEN>)
 id 1XEN4U-0004xg-UC
 for bug-gnu-emacs@HIDDEN; Mon, 04 Aug 2014 14:33:22 -0400
Received: from eggs.gnu.org ([2001:4830:134:3::10]:58800)
 by fencepost.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32)
 (Exim 4.71) (envelope-from <rrt@HIDDEN>) id 1XEN4U-0005Oa-M3
 for bug-emacs@HIDDEN; Mon, 04 Aug 2014 14:33:22 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <rrt@HIDDEN>) id 1XEN4T-0004x2-La
 for bug-emacs@HIDDEN; Mon, 04 Aug 2014 14:33:22 -0400
Received: from mail-la0-x236.google.com ([2a00:1450:4010:c03::236]:34696)
 by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <rrt@HIDDEN>)
 id 1XEN4T-0004wj-Bz
 for bug-emacs@HIDDEN; Mon, 04 Aug 2014 14:33:21 -0400
Received: by mail-la0-f54.google.com with SMTP id hz20so5623801lab.41
 for <bug-emacs@HIDDEN>; Mon, 04 Aug 2014 11:33:20 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sc3d.org; s=google;
 h=mime-version:date:message-id:subject:from:to:content-type;
 bh=wXxdn+B+lUZJteWPIhFQc/ZxCWnRxJ5kn+jjcyGtOHM=;
 b=xyOKQZyJStOIKjS7vfuHjLX7TjEPagm05digigS4D3A4+AW66Xx1aoi/lWRn/O11R8
 Z/bwNQpfwjlHBH+vAtYdPh0BvycPT5rKNhzNPk7vwCcKyw48bkAId4pHnY+JdxvV800b
 X6nqWGxVSvl2klbUhbmbuPGEfC7tn/JBR6Pgs=
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20130820;
 h=x-gm-message-state:mime-version:date:message-id:subject:from:to
 :content-type;
 bh=wXxdn+B+lUZJteWPIhFQc/ZxCWnRxJ5kn+jjcyGtOHM=;
 b=M1a1atjZGgkSwsYFflrRgi82+4tyqMH/TWz+FUOuvKg/fKZzeC5yt5RyYtnlmYjOYr
 aSo/L5mUYFvZG1raN0i+fjcEur5BccWeNRkYA5uZuu/HSP2A2E0YtjaqxmBFqiFtpxl5
 l20HUqUeHPmT086VvP0EEtC7reA/U5gH5duledzmdL6+lkwOykKNn3AowwwGrnjoa8+O
 lHua9gn7hZ07ROC0146VodaJ2vzLcDQCmHOJ5tdADfC7VI4qryI4In+y1za8oKSMuhwo
 f+iw2Om5ub5doocmT+7CLg5o+YtZixkLbL0twxxkO5F5pFT0t+UoOmQoat7oxk+AZ3wq
 FWSg==
X-Gm-Message-State: ALoCoQlo8AcW+CaVABak2SyG9uBFqopudmOhKoeUbMjp+eAy062AoevzH7FLFI1b17DUfSw40lZ4
MIME-Version: 1.0
X-Received: by 10.112.2.167 with SMTP id 7mr3922519lbv.103.1407177199928; Mon,
 04 Aug 2014 11:33:19 -0700 (PDT)
Received: by 10.152.246.10 with HTTP; Mon, 4 Aug 2014 11:33:19 -0700 (PDT)
Date: Mon, 4 Aug 2014 19:33:19 +0100
Message-ID: <CAOnWdoiL_KuFP_DpYZwENbGe8UpYjw=CGAZd8t616T3euYeW-g@HIDDEN>
Subject: Incorrect implication in delete-{backward,forward}-char docstrings
From: Reuben Thomas <rrt@HIDDEN>
To: bug-emacs <bug-emacs@HIDDEN>
Content-Type: multipart/alternative; boundary=14dae94ee019235fdc04ffd1f9d8
X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address
 (bad octet value).
X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address
 (bad octet value).
X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address
 (bad octet value).
X-Received-From: 2001:4830:134:3::11
X-Spam-Score: -4.1 (----)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <http://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <http://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <http://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -4.1 (----)

--14dae94ee019235fdc04ffd1f9d8
Content-Type: text/plain; charset=UTF-8

These two functions are marked interactive-only, yet the docstrings' last
sentence starts "Interactively," which may lead readers to infer that they
can be used non-interactively:

Interactively, N is the prefix arg, and
KILLFLAG is set if N was explicitly specified.

How about the following re-wording for the last sentence:

"A prefix arg becomes N, and sets KILLFLAG."

In fact, this solves another confusion: is pressing C-u "explicitly"
setting N? It might seem not, but it certainly causes KILLFLAG to be set.

If this is satisfactory, I can install a fix.

-- 
http://rrt.sc3d.org

--14dae94ee019235fdc04ffd1f9d8
Content-Type: text/html; charset=UTF-8

<div dir="ltr"><div><div><div>These two functions are marked interactive-only, yet the docstrings&#39; last sentence starts &quot;Interactively,&quot; which may lead readers to infer that they can be used non-interactively:<br>
<br>Interactively, N is the prefix arg, and<br>KILLFLAG is set if N was explicitly specified.<br><br></div>How about the following re-wording for the last sentence:<br><br></div>&quot;A prefix arg becomes N, and sets KILLFLAG.&quot;<br>
<br>In fact, this solves another confusion: is pressing C-u &quot;explicitly&quot; setting N? It might seem not, but it certainly causes KILLFLAG to be set.<br><br></div>If this is satisfactory, I can install a fix.<br clear="all">
<div><div><div><div><div><br>-- <br><a href="http://rrt.sc3d.org">http://rrt.sc3d.org</a>
</div></div></div></div></div></div>

--14dae94ee019235fdc04ffd1f9d8--