Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

[PATCH] Completion: Change plural descriptions to singular



From the completion style guide:

>Group descriptions should be singular because only one thing is being
>completed even though many may be listed. This applies even where you
>complete a list of the things.

Despite this, many functions use plural descriptions. The most noticeable for me
have always been the ones like ls and grep that override the default set by
_files. This patch fixes many of those; there are still a bunch left, but i
thought i'd limit myself

(Also, a few of the ones i changed weren't actually being applied because
they're overridden by a ->state description or because the type function they
call ignores the description set by _arguments. But they're still either wrong
or misleading, so i changed them anyway)

dana


diff --git a/Completion/BSD/Command/_fstat b/Completion/BSD/Command/_fstat
index 5487e6c0f..153378441 100644
--- a/Completion/BSD/Command/_fstat
+++ b/Completion/BSD/Command/_fstat
@@ -9,4 +9,4 @@ _arguments -s \
 '-p+[report all files open by the specified process]:process id:_pids' \
 '-u+[report all files open by the specified user]:user:_users' \
 '-v[verbose mode]' \
-'*:files:_files'
+'*: :_files'

diff --git a/Completion/Unix/Command/_awk b/Completion/Unix/Command/_awk
index 4063743e5..b23ecdf9d 100644
--- a/Completion/Unix/Command/_awk
+++ b/Completion/Unix/Command/_awk
@@ -21,7 +21,7 @@ args=(
   '*'{-v+,--assign}'[assign values to variables]:assignment:'
   '(1)*'{-f+,--file}'[read program file]:program file:->script'
   '1: :_guard "^-*" "program text"'
-  '*:input files:_files'
+  '*:input file:_files'
 )
 
 case $variant in

diff --git a/Completion/Unix/Command/_cat b/Completion/Unix/Command/_cat
index e383f8c6b..c78dc4cd9 100644
--- a/Completion/Unix/Command/_cat
+++ b/Completion/Unix/Command/_cat
@@ -16,7 +16,7 @@ if _pick_variant gnu=GNU unix --version; then
     '(-v --show-nonprinting)'{-v,--show-nonprinting}'[use ^ and M- notation, except for LFD and TAB]'
     '(- : *)--help[display help and exit]'
     '(- : *)--version[output version information and exit]'
-    '*:files:_files'
+    '*: :_files'
   )
 
 elif [[ "$OSTYPE" == (*bsd|dragonfly|darwin)* ]]; then
@@ -29,7 +29,7 @@ elif [[ "$OSTYPE" == (*bsd|dragonfly|darwin)* ]]; then
     '(-v)-t[display tab as ^I (implies -v)]'
     '-u[do not buffer output]'
     '-v[display non-printing chars as ^X or M-a]'
-    '*:files:_files'
+    '*: :_files'
   )
   [[ $OSTYPE = (free|net)bsd* ]] && args+=(
     '-l[set a lock on the stdout file descriptor]'
@@ -48,14 +48,14 @@ elif [[ $OSTYPE = solaris* ]]; then
     '-v[display non-printing chars as ^X or M-a]'
     '-e[display $ at the end of each line (requires -v)]'
     '-t[display tab as ^I and formfeeds and ^L (requires -v)]'
-    '*:files:_files'
+    '*: :_files'
   )
 else
   # POSIX reqires '-u', and most OSes may support '-n'
   args=(
     '-n[number all output lines]'
     '-u[do not buffer output]'
-    '*:files:_files'
+    '*: :_files'
   )
 fi
 

diff --git a/Completion/Unix/Command/_chown b/Completion/Unix/Command/_chown
index 2c63a399a..a97a0e0bf 100644
--- a/Completion/Unix/Command/_chown
+++ b/Completion/Unix/Command/_chown
@@ -40,7 +40,7 @@ else
 fi
 
 (( $+words[(r)--reference*] )) || args+=( '(--reference)1: :->owner' )
-_arguments -C -s "$args[@]" '*:files:->files' && ret=0
+_arguments -C -s "$args[@]" '*: :->files' && ret=0
 
 case $state in
   owner)

diff --git a/Completion/Unix/Command/_df b/Completion/Unix/Command/_df
index a31145cd4..21abff105 100644
--- a/Completion/Unix/Command/_df
+++ b/Completion/Unix/Command/_df
@@ -19,7 +19,7 @@ if _pick_variant gnu=GNU unix --version; then
     '!-v'
     '(- : *)--help[display help and exit]'
     '(- : *)--version[output version information and exit]'
-    '*:files:_umountable'
+    '*: :_umountable'
     - '(format)'
     {-B+,--block-size=}'[specify block size]:size (bytes)'
     '-k[like --block-size=1K]'
@@ -36,7 +36,7 @@ elif [[ "$OSTYPE" == (darwin|dragonfly|freebsd|netbsd*|openbsd)* ]]; then
     '(-G -i -P)-i[include inode usage statistics (default)]'
     '-l[only display locally-mounted file systems]'
     '-n[use previously obtained statistics]'
-    '*:files:_umountable'
+    '*: :_umountable'
   )
   spec='[only display file systems of specified types]:file system type:->fslist'
   case "$OSTYPE" in
@@ -93,7 +93,7 @@ else
     '-k[use 1024-byte blocks]'
     '-P[POSIX compliant output]'
     '-t[include total allocated-space figures in the output]'
-    '*:files:_umountable'
+    '*: :_umountable'
   )
 fi
 

diff --git a/Completion/Unix/Command/_grep b/Completion/Unix/Command/_grep
index 3bc8d3fe0..d3e1b1a6e 100644
--- a/Completion/Unix/Command/_grep
+++ b/Completion/Unix/Command/_grep
@@ -10,11 +10,11 @@ if [[ $service = *GREP_OPT* ]]; then
 else
   arguments=( '(-e --regexp -f --file)1: :_guard "^-*" pattern' )
   if [[ $service = z* ]]; then
-    arguments+=( '*:files:_files -g "*.gz(-.)"' )
+    arguments+=( '*: :_files -g "*.gz(-.)"' )
   elif [[ $service = bz* ]]; then
-    arguments+=( '*:files:_files -g "*.bz2(-.)"' )
+    arguments+=( '*: :_files -g "*.bz2(-.)"' )
   else
-    arguments+=( '*:files:_files' )
+    arguments+=( '*: :_files' )
   fi
   command="$words[1]"
 fi

diff --git a/Completion/Unix/Command/_ls b/Completion/Unix/Command/_ls
index ea96de6ff..cedea1de9 100644
--- a/Completion/Unix/Command/_ls
+++ b/Completion/Unix/Command/_ls
@@ -37,7 +37,7 @@ if ! _pick_variant gnu=gnu unix --help; then
 
     '(-B -b -w -q)-q[hide control chars]'
 
-    '*:files:_files'
+    '*: :_files'
   )
   if [[ "$OSTYPE" = (netbsd*|dragonfly*|freebsd*|openbsd*|darwin*) ]]; then
     arguments+=(

diff --git a/Completion/Unix/Command/_od b/Completion/Unix/Command/_od
index aba400660..046018131 100644
--- a/Completion/Unix/Command/_od
+++ b/Completion/Unix/Command/_od
@@ -61,7 +61,7 @@ else
   esac
 fi
 
-_arguments -C -s -S : "$args[@]" '*:files:_files' && return 0
+_arguments -C -s -S : "$args[@]" '*: :_files' && return 0
 
 case "$state" in
   (format)

diff --git a/Completion/Unix/Command/_pax b/Completion/Unix/Command/_pax
index 7ebaa6aa5..0ae58423c 100644
--- a/Completion/Unix/Command/_pax
+++ b/Completion/Unix/Command/_pax
@@ -44,4 +44,4 @@ _arguments -s \
   '-X[do not descend into directories that have a different device ID]' \
   '-Y[ignore older files by ctime after file name mods]' \
   '-Z[ignore older files after file name mods]' \
-  '*:files:_files'
+  '*: :_files'

diff --git a/Completion/Unix/Command/_rar b/Completion/Unix/Command/_rar
index 906e236fd..68982be60 100644
--- a/Completion/Unix/Command/_rar
+++ b/Completion/Unix/Command/_rar
@@ -58,7 +58,7 @@ case $service in
 	'-n+:file to include:_files' \
 	'-n@+:file of files to include:_files' \
         "$common[@]" \
-        '*:RAR files:_files -g \*.rar\(-.\)'
+        '*:RAR file:_files -g \*.rar\(-.\)'
     fi
   ;;
   rar)
@@ -126,7 +126,7 @@ case $service in
 	'-w+[assign work directory]:work directory:_files -/' \
 	"$common[@]" \
 	'-z+[read archive comment from file]:comment file:_files' \
-	'*:files:_files'
+	'*: :_files'
     fi
   ;;
 esac

diff --git a/Completion/Unix/Command/_rm b/Completion/Unix/Command/_rm
index 912b5eadf..aa24a3fd6 100644
--- a/Completion/Unix/Command/_rm
+++ b/Completion/Unix/Command/_rm
@@ -5,7 +5,7 @@ args=(
   '(-f --force)'{-f,--force}'[ignore nonexistent files, never prompt]'
   '(-I --interactive)-i[prompt before every removal]'
   '(-r -R --recursive)'{-r,-R,--recursive}'[remove directories and their contents recursively]'
-  '*::files:->file'
+  '*:: :->file'
 )
 if _pick_variant gnu=gnu unix --help; then
   opts+=(-S)

diff --git a/Completion/Unix/Command/_xxd b/Completion/Unix/Command/_xxd
index 0034be519..3a8efd664 100644
--- a/Completion/Unix/Command/_xxd
+++ b/Completion/Unix/Command/_xxd
@@ -41,7 +41,7 @@ arguments=(
   {-o+,-offset}'[add specified offset to displayed file position]:offset'
   {-s,-skip,-seek}'[specify file offset to dump from]: :_guard "[0-9]#" "file offset to dump from (absolute or relative)"'
 
-  ':files:_files'
+  ': :_files'
 )
 
 _arguments -S $arguments



Messages sorted by: Reverse Date, Date, Thread, Author