zsh-workers
 help / color / mirror / code / Atom feed
From: dana <dana@dana.is>
To: Zsh Workers List <zsh-workers@zsh.org>
Subject: [PATCH] Clarify _files documentation
Date: Mon, 16 Dec 2019 15:55:09 -0600	[thread overview]
Message-ID: <89AE8F2C-D757-4452-BDBB-89AC0C1B7D0C@dana.is> (raw)

Someone on IRC was confused about the purpose of _files — what they took away
from the documentation was that it lacks functionality that _path_files has.
I feel like this should clarify things

dana


diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index db669fae3..130e85148 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -4518,9 +4518,12 @@ New plugins will be picked up and run automatically.
 )
 findex(_files)
 item(tt(_files))(
-The function tt(_files) calls tt(_path_files) with all the arguments it
-was passed except for tt(-g) and tt(-/).  The use of these two options
-depends on the setting of the  tt(file-patterns) style.
+The function tt(_files) is a wrapper around tt(_path_files). It supports
+all of the same functionality, with some enhancements DASH()- notably, it
+respects the tt(list-dirs-first) style, and it allows users to override
+the behaviour of the tt(-g) and tt(-/) options with the tt(file-patterns)
+style. tt(_files) should therefore be preferred over tt(_path_files) in
+most cases.
 
 This function accepts the full set of options allowed by
 tt(_path_files), described below.


                 reply	other threads:[~2019-12-16 21:55 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=89AE8F2C-D757-4452-BDBB-89AC0C1B7D0C@dana.is \
    --to=dana@dana.is \
    --cc=zsh-workers@zsh.org \
    /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 public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).