From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#15047: 24.3.50; doc string of `find-listp-find-files' etc. Date: Fri, 29 Apr 2016 15:36:32 +0200 Message-ID: <87inz08rkv.fsf@gnus.org> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461937231 23859 80.91.229.3 (29 Apr 2016 13:40:31 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 29 Apr 2016 13:40:31 +0000 (UTC) Cc: 15047@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Apr 29 15:40:16 2016 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 1aw8eV-00069I-K2 for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Apr 2016 15:40:15 +0200 Original-Received: from localhost ([::1]:54510 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aw8eR-0000IK-QW for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Apr 2016 09:40:11 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:44609) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aw8be-0003fk-48 for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 09:37:25 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aw8bS-0004fl-67 for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 09:37:12 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:41795) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aw8bS-0004eN-3l for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 09:37:06 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1aw8bO-0003vw-OT for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 09:37:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 29 Apr 2016 13:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 15047 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 15047-submit@debbugs.gnu.org id=B15047.146193699915071 (code B ref 15047); Fri, 29 Apr 2016 13:37:02 +0000 Original-Received: (at 15047) by debbugs.gnu.org; 29 Apr 2016 13:36:39 +0000 Original-Received: from localhost ([127.0.0.1]:54128 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1aw8b1-0003v1-J6 for submit@debbugs.gnu.org; Fri, 29 Apr 2016 09:36:39 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:55147) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1aw8b0-0003ut-2v for 15047@debbugs.gnu.org; Fri, 29 Apr 2016 09:36:38 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1aw8au-0008Ut-M4; Fri, 29 Apr 2016 15:36:36 +0200 In-Reply-To: (Drew Adams's message of "Wed, 7 Aug 2013 15:06:23 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:117169 Archived-At: Drew Adams writes: > The doc should distinguish between the files _within_ a directory, i.e., > descending into its subdirectories recursively, and the files in a > directory, i.e., not including in descendent directories. > > Pick any terminology you like, but please make it clear. > > 1. `find-listp-find-files': The doc of does not at all indicate that it > in fact searches also subdirectories, recursively. Fixed... > 2. `find-lisp-find-files-internal': The doc says that > "DIRECTORY-PREDICATE is used to decide...", but it does not say how, > which is central to the meaning of DIRECTORY-PREDICATE. Just say that > if DIRECTORY-PREDICATE returns non-nil then descend into subdirs etc. It's a predicate. That's what predicates do. > 3. `find-lisp-find-dired-internal': The doc says "Run find...". > Please change this to "Run `find'...". But it doesn't run the command `find'. And it says: "Run find (Lisp version) and go into Dired mode on a buffer of the output." > 4. `find-lisp-find-dired-filter': Please replace the doc string with > something correct or useful. The command does not "change the > filter..." or anything of the kind. And please wrap function names with > `...' in doc. But it does change the filter... ;;;###autoload (defun find-lisp-find-dired-filter (regexp) "Change the filter on a `find-lisp-find-dired' buffer to REGEXP." (interactive "sSet filter to regexp: ") (setq find-lisp-regexp regexp) (revert-buffer)) And I see that Juanma has already fixed the quoting... > 5. `find-lisp-format': Add a doc string. You "lifted" this from > ls-lisp.el, but you neglected to lift the doc string along with it. Done. > 6. `find-lisp-time-index', `find-lisp-format-time': Replace the code > comments with doc strings. This is the 21st century; we can afford > the extra cost. ;-) Done. > 7. `find-lisp-find-dired-insert-file': Add a doc string. Seems unnecessary. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no