From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#2035: 23.0.60; doc string of dired-read-shell-command Date: Fri, 13 Feb 2009 07:09:23 -0800 Message-ID: <001501c98ded$0e4c8070$0200a8c0@us.oracle.com> References: <001a01c97e9c$55a8e5e0$0200a8c0@us.oracle.com> Reply-To: Drew Adams , 2035@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 1234538632 12966 80.91.229.12 (13 Feb 2009 15:23:52 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 13 Feb 2009 15:23:52 +0000 (UTC) Cc: 2035@emacsbugs.donarmstrong.com To: "'Juanma Barranquero'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Feb 13 16:25:08 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 1LXzud-0006OS-3x for geb-bug-gnu-emacs@m.gmane.org; Fri, 13 Feb 2009 16:25:07 +0100 Original-Received: from localhost ([127.0.0.1]:55305 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1LXztI-0000tF-Mc for geb-bug-gnu-emacs@m.gmane.org; Fri, 13 Feb 2009 10:23:44 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1LXztD-0000sO-Gu for bug-gnu-emacs@gnu.org; Fri, 13 Feb 2009 10:23:39 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1LXztC-0000rs-I9 for bug-gnu-emacs@gnu.org; Fri, 13 Feb 2009 10:23:39 -0500 Original-Received: from [199.232.76.173] (port=53709 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1LXztC-0000rj-A1 for bug-gnu-emacs@gnu.org; Fri, 13 Feb 2009 10:23:38 -0500 Original-Received: from rzlab.ucr.edu ([138.23.92.77]:32964) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1LXztB-00014M-Pt for bug-gnu-emacs@gnu.org; Fri, 13 Feb 2009 10:23:38 -0500 Original-Received: from rzlab.ucr.edu (rzlab.ucr.edu [127.0.0.1]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id n1DFNYds016711; Fri, 13 Feb 2009 07:23:34 -0800 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.13.8/8.13.8/Submit) id n1DFF3c0013809; Fri, 13 Feb 2009 07:15:03 -0800 X-Loop: owner@emacsbugs.donarmstrong.com Resent-From: "Drew Adams" Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs , owner@emacsbugs.donarmstrong.com Resent-Date: Fri, 13 Feb 2009 15:15:03 +0000 Resent-Message-ID: Resent-Sender: owner@emacsbugs.donarmstrong.com X-Emacs-PR-Message: followup 2035 X-Emacs-PR-Package: emacs,documentation X-Emacs-PR-Keywords: Original-Received: via spool by 2035-submit@emacsbugs.donarmstrong.com id=B2035.123453777812156 (code B ref 2035); Fri, 13 Feb 2009 15:15:03 +0000 Original-Received: (at 2035) by emacsbugs.donarmstrong.com; 13 Feb 2009 15:09:38 +0000 X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. Original-Received: from acsinet11.oracle.com (acsinet11.oracle.com [141.146.126.233]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id n1DF9YmZ012143 for <2035@emacsbugs.donarmstrong.com>; Fri, 13 Feb 2009 07:09:36 -0800 Original-Received: from rgminet15.oracle.com (rcsinet15.oracle.com [148.87.113.117]) by acsinet11.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n1DF9fhp001989 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 13 Feb 2009 15:09:43 GMT Original-Received: from acsmt701.oracle.com (acsmt701.oracle.com [141.146.40.71]) by rgminet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n1DF9PJW027048; Fri, 13 Feb 2009 15:09:26 GMT Original-Received: from dradamslap1 (/141.144.80.181) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 13 Feb 2009 07:09:22 -0800 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: Thread-Index: AcmN0VkkeKKji8neSVy9p/mElCv3OwAGzNEQ X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3350 X-Source-IP: acsmt701.oracle.com [141.146.40.71] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A010204.49958D26.0019:SCFSTAT928724,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 3) Resent-Date: Fri, 13 Feb 2009 10:23:39 -0500 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:25301 Archived-At: > From: Juanma Barranquero Sent: Friday, February 13, 2009 3:49 AM > > 1. The part about the "prefix arg", at least, doesn't make > > sense. This is not a command, and there is no reference in the code to > > `current-prefix-arg'. The sentence is not clear to me, even ignoring > > "prefix" - *how* does ARG indicate, in the prompt, which files are > > affected? > > It makes somewhat more sense if you look at the original version in > dired-aux.el. > > > 2. Argument FILES is not described (should be uppercase). > > It is fixed in the dired-aux version :( > > > 3. It's not clear (to me) what the last sentence is > > supposed to mean. > > Is part of a comment in the original version. > > All in all, I think the docstring should say: "This is an internal > function." and little more. The info in the docstring should have > stayed a comment IMHO. It's not necessarily an internal function. It's a non-interactive function, but there is no reason that other code can't also call it. The doc string should explain what the function does, as always (but not how it does it).