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#11553: 24.0.97; doc string of `dired-mark-read-string' Date: Thu, 24 May 2012 11:27:28 -0700 Message-ID: <49EDCA00FEBE4FDD8F5D2F934863D6AE@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1337884162 8558 80.91.229.3 (24 May 2012 18:29:22 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Thu, 24 May 2012 18:29:22 +0000 (UTC) To: 11553@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu May 24 20:29:21 2012 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 1SXcmj-0006D7-9u for geb-bug-gnu-emacs@m.gmane.org; Thu, 24 May 2012 20:29:17 +0200 Original-Received: from localhost ([::1]:52021 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SXcmi-0007jX-O5 for geb-bug-gnu-emacs@m.gmane.org; Thu, 24 May 2012 14:29:16 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:40721) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SXcmd-0007it-77 for bug-gnu-emacs@gnu.org; Thu, 24 May 2012 14:29:15 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SXcmY-0001SN-Pc for bug-gnu-emacs@gnu.org; Thu, 24 May 2012 14:29:10 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:32848) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SXcmY-0001SC-MM for bug-gnu-emacs@gnu.org; Thu, 24 May 2012 14:29:06 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1SXcnS-0004qo-8r for bug-gnu-emacs@gnu.org; Thu, 24 May 2012 14:30:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 24 May 2012 18:30:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 11553 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: Original-Received: via spool by submit@debbugs.gnu.org id=B.133788415218562 (code B ref -1); Thu, 24 May 2012 18:30:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 24 May 2012 18:29:12 +0000 Original-Received: from localhost ([127.0.0.1]:42394 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1SXcme-0004pK-5z for submit@debbugs.gnu.org; Thu, 24 May 2012 14:29:12 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:33884) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1SXcmJ-0004oV-9O for submit@debbugs.gnu.org; Thu, 24 May 2012 14:29:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SXclG-0000y1-83 for submit@debbugs.gnu.org; Thu, 24 May 2012 14:27:49 -0400 Original-Received: from lists.gnu.org ([208.118.235.17]:33056) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SXclG-0000xr-4V for submit@debbugs.gnu.org; Thu, 24 May 2012 14:27:46 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:40381) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SXclB-0007XX-U2 for bug-gnu-emacs@gnu.org; Thu, 24 May 2012 14:27:45 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SXcl7-0000uB-9h for bug-gnu-emacs@gnu.org; Thu, 24 May 2012 14:27:41 -0400 Original-Received: from acsinet15.oracle.com ([141.146.126.227]:35374) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SXcl7-0000sk-3j for bug-gnu-emacs@gnu.org; Thu, 24 May 2012 14:27:37 -0400 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by acsinet15.oracle.com (Sentrion-MTA-4.2.2/Sentrion-MTA-4.2.2) with ESMTP id q4OIRVVJ029802 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Thu, 24 May 2012 18:27:32 GMT Original-Received: from acsmt358.oracle.com (acsmt358.oracle.com [141.146.40.158]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id q4OIRUJi029918 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Thu, 24 May 2012 18:27:30 GMT Original-Received: from abhmt101.oracle.com (abhmt101.oracle.com [141.146.116.53]) by acsmt358.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id q4OIRU3G008956 for ; Thu, 24 May 2012 13:27:30 -0500 Original-Received: from dradamslap1 (/130.35.178.194) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Thu, 24 May 2012 11:27:29 -0700 X-Mailer: Microsoft Office Outlook 11 Thread-Index: Ac052t//c0s1kCcwQvq43JqbnnXigA== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 1) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) 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:60339 Archived-At: The doc string includes this: 1. "ARG is normally the prefix argument for the calling command." So what? That doesn't tell you anything useful. What is ARG for? What does it do? Just say that it is passed to `dired-mark-prompt'. 2. "FILES should be a list of file names." No. That kind of help is no help at all. FILES is the list of _marked_ files. 3. "DEFAULT-VALUE, if non-nil, should be a "standard" value or list of such values, available via history commands. Note that if the user enters empty input, this function returns the empty string, not DEFAULT-VALUE." The first sentence: Does it say anything useful? If so, it's not clear to me. It seems to be saying only that DEFAULT-VALUE is a default value or list of default values. It would be far clearer and actually helpful if you just said that DEFAULT-VALUE is passed to `completing-read'. IOW, do what you did for COLLECTION. Just say that INITIAL, DEFAULT-VALUE, and COLLECTION are passed to `completing-read'. That will provide a link to `completing-read', whose doc provides complete and accurate descriptions of these arguments. In GNU Emacs 24.0.97.1 (i386-mingw-nt5.1.2600) of 2012-05-16 on MARVIN Windowing system distributor `Microsoft Corp.', version 5.1.2600 Configured using: `configure --with-gcc (4.6) --no-opt --enable-checking --cflags -ID:/devel/emacs/libs/libXpm-3.5.8/include -ID:/devel/emacs/libs/libXpm-3.5.8/src -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include -ID:/devel/emacs/libs/giflib-4.1.4-1/include -ID:/devel/emacs/libs/jpeg-6b-4/include -ID:/devel/emacs/libs/tiff-3.8.2-1/include -ID:/devel/emacs/libs/gnutls-3.0.9/include'