From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <zsh-workers-return-45055-ml=inbox.vuxu.org@zsh.org>
X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on inbox.vuxu.org
X-Spam-Level: 
X-Spam-Status: No, score=-1.0 required=5.0 tests=MAILING_LIST_MULTI,
	RCVD_IN_DNSWL_NONE autolearn=ham autolearn_force=no version=3.4.2
Received: from primenet.com.au (ns1.primenet.com.au [203.24.36.2])
	by inbox.vuxu.org (OpenSMTPD) with ESMTP id 1acdb335
	for <ml@inbox.vuxu.org>;
	Mon, 16 Dec 2019 21:55:52 +0000 (UTC)
Received: (qmail 15861 invoked by alias); 16 Dec 2019 21:55:47 -0000
Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm
Precedence: bulk
X-No-Archive: yes
List-Id: Zsh Workers List <zsh-workers.zsh.org>
List-Post: <mailto:zsh-workers@zsh.org>
List-Help: <mailto:zsh-workers-help@zsh.org>
List-Unsubscribe: <mailto:zsh-workers-unsubscribe@zsh.org>
X-Seq: 45055
Received: (qmail 1273 invoked by uid 1010); 16 Dec 2019 21:55:47 -0000
X-Qmail-Scanner-Diagnostics: from mail-yb1-f169.google.com by f.primenet.com.au (envelope-from <dana@dana.is>, uid 7791) with qmail-scanner-2.11 
 (clamdscan: 0.102.1/25663. spamassassin: 3.4.2.  
 Clear:RC:0(209.85.219.169):SA:0(-1.9/5.0):. 
 Processed in 1.919405 secs); 16 Dec 2019 21:55:47 -0000
X-Envelope-From: dana@dana.is
X-Qmail-Scanner-Mime-Attachments: |
X-Qmail-Scanner-Zip-Files: |
Received-SPF: pass (ns1.primenet.com.au: SPF record at _netblocks.google.com designates 209.85.219.169 as permitted sender)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=1e100.net; s=20161025;
        h=x-gm-message-state:from:content-transfer-encoding:mime-version
         :subject:message-id:date:to;
        bh=GOsdb0yPu7jQURjhsYb46USyfhMal82qgW9PlBo2sFk=;
        b=D/rbaL210Z0Oqvytn/ORFE3SsZYZELm/AcTIZYM7TgD4eiUJpmbAT1uw6ZTHZ7PUY8
         1C9wak5LiSgOgF8GeGMFQUUvtYOcNR5hVrmLk/nCVKrf7AAAOQMVuIygAmrCJrWXx7W4
         LBWmXp7KCsrlqlhMXrM+PttQju7fgrGTXTuzCdqG9v3bFgD201Q5qPIq3eFLRlwb5+oS
         2wc4bdwPvFd5zbe9isjiUvV1MZ3Ha45tVT/+JJcVEU9p3srcjDHBZgEGJBrqQ1MHDyiG
         HvoPG2Xr5QHTmcijNDpCyxYL97WxInCzMm7dKpyYLXu8zBZCJMk/XLCQf2Lo0RnLk6VJ
         Au3g==
X-Gm-Message-State: APjAAAV8/cNN1uDz/MA44rg3Fg7leQR7hGMQ54Nc8aFj0EbvO72pjCv8
	D1Qh86MlBovoTGUfVzFpPvyIyPVTTH9TYw==
X-Google-Smtp-Source: APXvYqzS7Q30rSKqGmkz/l6Rq1+qtjlj1Y4UEFEgmU9LKZSuVnI50hLRB4yi5F+1STfM1y6u9h5PSQ==
X-Received: by 2002:a25:252:: with SMTP id 79mr13078859ybc.195.1576533312601;
        Mon, 16 Dec 2019 13:55:12 -0800 (PST)
From: dana <dana@dana.is>
Content-Type: text/plain;
	charset=utf-8
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (Mac OS X Mail 12.4 \(3445.104.11\))
Subject: [PATCH] Clarify _files documentation
Message-Id: <89AE8F2C-D757-4452-BDBB-89AC0C1B7D0C@dana.is>
Date: Mon, 16 Dec 2019 15:55:09 -0600
To: Zsh Workers List <zsh-workers@zsh.org>
X-Mailer: Apple Mail (2.3445.104.11)

Someone on IRC was confused about the purpose of _files =E2=80=94 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.
=20
 This function accepts the full set of options allowed by
 tt(_path_files), described below.