zsh-workers
 help / color / mirror / code / Atom feed
* [PATCH] Clarify _files documentation
@ 2019-12-16 21:55 dana
  0 siblings, 0 replies; only message in thread
From: dana @ 2019-12-16 21:55 UTC (permalink / raw)
  To: Zsh Workers List

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.


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2019-12-16 21:55 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-16 21:55 [PATCH] Clarify _files documentation dana

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).