about summary refs log tree commit diff
path: root/Doc
diff options
context:
space:
mode:
authordana <dana@dana.is>2019-12-20 15:31:34 -0600
committerdana <dana@dana.is>2019-12-20 15:31:34 -0600
commit6fd40238256bf05e855bd728289740e9e21eae44 (patch)
tree3ddbe455e4e1f7f6ce1bbbcd6fb5f81880b3b319 /Doc
parentfd068221b7fbbcfe89ec74c7eeb0138e90e14b13 (diff)
downloadzsh-6fd40238256bf05e855bd728289740e9e21eae44.tar.gz
zsh-6fd40238256bf05e855bd728289740e9e21eae44.tar.xz
zsh-6fd40238256bf05e855bd728289740e9e21eae44.zip
45055: Clarify _files documentation
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/compsys.yo9
1 files changed, 6 insertions, 3 deletions
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.