all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 15047@debbugs.gnu.org
Subject: bug#15047: 24.3.50; doc string of `find-listp-find-files' etc.
Date: Fri, 29 Apr 2016 15:36:32 +0200	[thread overview]
Message-ID: <87inz08rkv.fsf@gnus.org> (raw)
In-Reply-To: <c6ae2502-c131-4e68-a5ac-3dc6a29c32ee@default> (Drew Adams's message of "Wed, 7 Aug 2013 15:06:23 -0700 (PDT)")

Drew Adams <drew.adams@oracle.com> 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





  reply	other threads:[~2016-04-29 13:36 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-08-07 22:06 bug#15047: 24.3.50; doc string of `find-listp-find-files' etc Drew Adams
2016-04-29 13:36 ` Lars Ingebrigtsen [this message]
2016-04-29 17:19   ` Drew Adams
2016-05-01 13:46     ` Michael Heerdegen
2016-05-01 14:28       ` Drew Adams
2016-05-01 15:12         ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87inz08rkv.fsf@gnus.org \
    --to=larsi@gnus.org \
    --cc=15047@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.