From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Reuben Thomas Newsgroups: gmane.emacs.bugs Subject: bug#18192: Incorrect implication in delete-{backward, forward}-char docstrings Date: Mon, 4 Aug 2014 19:33:19 +0100 Message-ID: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=14dae94ee019235fdc04ffd1f9d8 X-Trace: ger.gmane.org 1407177267 12520 80.91.229.3 (4 Aug 2014 18:34:27 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 4 Aug 2014 18:34:27 +0000 (UTC) To: 18192@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Aug 04 20:34:21 2014 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 1XEN5N-0006ue-Ek for geb-bug-gnu-emacs@m.gmane.org; Mon, 04 Aug 2014 20:34:17 +0200 Original-Received: from localhost ([::1]:54116 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEN5M-0000Z8-Rj for geb-bug-gnu-emacs@m.gmane.org; Mon, 04 Aug 2014 14:34:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:35082) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEN5I-0000Xk-OR for bug-gnu-emacs@gnu.org; Mon, 04 Aug 2014 14:34:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEN58-0005Di-Aw for bug-gnu-emacs@gnu.org; Mon, 04 Aug 2014 14:34:12 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:50617) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEN58-0005DM-8K for bug-gnu-emacs@gnu.org; Mon, 04 Aug 2014 14:34:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1XEN57-00025D-PE for bug-gnu-emacs@gnu.org; Mon, 04 Aug 2014 14:34:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Reuben Thomas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 04 Aug 2014 18:34:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 18192 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-emacs Original-Received: via spool by submit@debbugs.gnu.org id=B.14071772187956 (code B ref -1); Mon, 04 Aug 2014 18:34:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 4 Aug 2014 18:33:38 +0000 Original-Received: from localhost ([127.0.0.1]:57557 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XEN4j-00024G-Nc for submit@debbugs.gnu.org; Mon, 04 Aug 2014 14:33:38 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:32946) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XEN4h-00023z-J6 for submit@debbugs.gnu.org; Mon, 04 Aug 2014 14:33:36 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEN4b-00050u-Bc for submit@debbugs.gnu.org; Mon, 04 Aug 2014 14:33:30 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:33420) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEN4b-00050n-8H for submit@debbugs.gnu.org; Mon, 04 Aug 2014 14:33:29 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34661) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEN4a-0000Ql-0I for bug-gnu-emacs@gnu.org; Mon, 04 Aug 2014 14:33:29 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEN4V-0004xk-13 for bug-gnu-emacs@gnu.org; Mon, 04 Aug 2014 14:33:27 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:44297) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEN4U-0004xg-UC for bug-gnu-emacs@gnu.org; Mon, 04 Aug 2014 14:33:22 -0400 Original-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 ) id 1XEN4U-0005Oa-M3 for bug-emacs@gnu.org; Mon, 04 Aug 2014 14:33:22 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEN4T-0004x2-La for bug-emacs@gnu.org; Mon, 04 Aug 2014 14:33:22 -0400 Original-Received: from mail-la0-x236.google.com ([2a00:1450:4010:c03::236]:34696) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEN4T-0004wj-Bz for bug-emacs@gnu.org; Mon, 04 Aug 2014 14:33:21 -0400 Original-Received: by mail-la0-f54.google.com with SMTP id hz20so5623801lab.41 for ; 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 X-Received: by 10.112.2.167 with SMTP id 7mr3922519lbv.103.1407177199928; Mon, 04 Aug 2014 11:33:19 -0700 (PDT) Original-Received: by 10.152.246.10 with HTTP; Mon, 4 Aug 2014 11:33:19 -0700 (PDT) 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-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:92104 Archived-At: --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
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.
--14dae94ee019235fdc04ffd1f9d8--