From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs,gmane.emacs.pretest.bugs Subject: bug#3936: 23.0.96; doc string of called-interactively-p Date: Mon, 27 Jul 2009 01:18:45 -0700 Message-ID: <5D6C9B27AFE44D5BA9E8EC53F6BA9CB9@us.oracle.com> References: <09B238050EFB472EBBBFDCFF9B184113@us.oracle.com><878wiaq3tl.fsf@bzg.ath.cx> <87r5w2lj6v.fsf@bzg.ath.cx> Reply-To: Drew Adams , 3936@emacsbugs.donarmstrong.com NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1248683893 445 80.91.229.12 (27 Jul 2009 08:38:13 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 27 Jul 2009 08:38:13 +0000 (UTC) Cc: emacs-pretest-bug@gnu.org, 3936@emacsbugs.donarmstrong.com To: "'Bastien'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jul 27 10:38:05 2009 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1MVLiY-0000oS-RG for geb-bug-gnu-emacs@m.gmane.org; Mon, 27 Jul 2009 10:37:59 +0200 Original-Received: from localhost ([127.0.0.1]:37382 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MVLiY-00068v-A2 for geb-bug-gnu-emacs@m.gmane.org; Mon, 27 Jul 2009 04:37:58 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MVLiF-00064N-8n for bug-gnu-emacs@gnu.org; Mon, 27 Jul 2009 04:37:39 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MVLiA-00063P-DA for bug-gnu-emacs@gnu.org; Mon, 27 Jul 2009 04:37:38 -0400 Original-Received: from [199.232.76.173] (port=33600 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MVLiA-00063I-6z for bug-gnu-emacs@gnu.org; Mon, 27 Jul 2009 04:37:34 -0400 Original-Received: from rzlab.ucr.edu ([138.23.92.77]:54059) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1MVLi9-00034q-E7 for bug-gnu-emacs@gnu.org; Mon, 27 Jul 2009 04:37:33 -0400 Original-Received: from rzlab.ucr.edu (rzlab.ucr.edu [127.0.0.1]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n6R8bUwv000878; Mon, 27 Jul 2009 01:37:31 -0700 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.14.3/8.14.3/Submit) id n6R8P9gf031285; Mon, 27 Jul 2009 01:25:09 -0700 X-Loop: owner@emacsbugs.donarmstrong.com Resent-From: "Drew Adams" Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs Resent-Date: Mon, 27 Jul 2009 08:25:09 +0000 Resent-Message-ID: Resent-Sender: owner@emacsbugs.donarmstrong.com X-Emacs-PR-Message: followup 3936 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: Original-Received: via spool by 3936-submit@emacsbugs.donarmstrong.com id=B3936.124868272030298 (code B ref 3936); Mon, 27 Jul 2009 08:25:09 +0000 Original-Received: (at 3936) by emacsbugs.donarmstrong.com; 27 Jul 2009 08:18:40 +0000 X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. Original-Received: from acsinet12.oracle.com (acsinet12.oracle.com [141.146.126.234]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n6R8IZPv030286 for <3936@emacsbugs.donarmstrong.com>; Mon, 27 Jul 2009 01:18:36 -0700 Original-Received: from acsinet15.oracle.com (acsinet15.oracle.com [141.146.126.227]) by acsinet12.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n6R8I8xJ021978 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Mon, 27 Jul 2009 08:18:09 GMT Original-Received: from abhmt002.oracle.com (abhmt002.oracle.com [141.146.116.11]) by acsinet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n6R8IcO9029656; Mon, 27 Jul 2009 08:18:38 GMT Original-Received: from dradamslap1 (/141.144.232.119) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Mon, 27 Jul 2009 01:18:26 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <87r5w2lj6v.fsf@bzg.ath.cx> X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5579 Thread-Index: AcoOha2ifG9C2E9sS/6jb/HhkwLJKgACG/bQ X-Source-IP: abhmt002.oracle.com [141.146.116.11] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A010208.4A6D62D3.001A:SCFSTAT5015188,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 2) Resent-Date: Mon, 27 Jul 2009 04:37:38 -0400 X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:29653 gmane.emacs.pretest.bugs:24858 Archived-At: > > I really don't understand what you are trying to say. > > Are you sure? Even the name of this function is very explicit: > "call-interactively-p", and I bet you know what it does - so it > shouldn't be hard to guess what the docstring is trying to say. (`called-interactively-p', not `call-interactively-p'.) And no, I don't know exactly what it does - its C code is hard for me to follow. Here is what the doc string of `interactive-p' said, back in Emacs 20-21: "Return t if function in which this appears was called interactively." That's a little clearer, though it too speaks of "this". To me, "in which this appears" is clearer than "using this". > > When does `called-interactively-p' return t? > > When the function in which (call-interactively-p) is has been > interactively called with (call-interactively ...) "_interactively_ called with (call-interactively...)" Is it a joke? How about just "called using `call-interactively'"? > > It should be possible to describe that > > condition. What does the code say? > > Please suggest something better - with this small annoying constraints > that the first line has to be quite short. The first line has to be short. The rest doesn't have to be short. See what was said before for `interactive-p' - it's not too bad. In particular, the doc strings of `called-interactively-p' and `interactive-p' should, together, make clear their difference. They can't both just say that they test for an interactive call. They need to speak about keyboard macro use as the difference in behavior. See also bug #3941, preferably before fixing this doc string. The doc of both of these functions is a mess in general, IMO.