1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2025-09-02 22:11:54 +02:00

18877: add note about supporting latest versions, tag names being plural etc

This commit is contained in:
Oliver Kiddle 2003-07-23 11:06:58 +00:00
parent 93141e6960
commit c3a03617ea
2 changed files with 19 additions and 1 deletions

View file

@ -1,3 +1,7 @@
2003-07-23 Oliver Kiddle <opk@zsh.org>
* 18877: Etc/completion-style-guide: add a few more points
2003-07-23 Peter Stephenson <pws@csr.com>
* 18888: Philippe Troin: Src/Modules/clone.c: Allow clone to

View file

@ -17,7 +17,8 @@ Coding style:
isn't room for it (see the next point) in which case put it on the
next line un-indented.
* Please try not to use lines longer than 79 characters.
* Please try not to use lines longer than 79 characters. Don't worry
about breaking long `_arguments' or `_values' specs though.
Descriptions:
@ -49,6 +50,11 @@ for example, do not use:
but use:
'--timeout[specify connection timeout]:timeout (ms)'
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. Tags, functions for completing types of
things (such as _files), and states should have plural names.
In a function, allow any descriptions passed as an argument to override
the default you define. For example:
_wanted directories expl directory _files -/ "$@" -
@ -65,6 +71,14 @@ matches which are completely opposite in their meaning if it shortens
the completion listing provided that the names of the matches makes it
clear what their effect is.
Command Versions:
In most cases multiple versions (releases) of commands are not
supported. The functions are merely updated to reflect the latest stable
version. Exceptions to this can be made where are particular version
continues to be commonly distributed. Where there is more than one variant
of the same command however, the separate variants should be supported.
Contexts, tags and all that
---------------------------