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

PATCH: RE: Examples in _arguments description



Andrej Borsenkow wrote:

> > > The second example `(-foo):...' is not mentioned anywhere
> > and looks a
> > > bit strange anyway.
> >
> > What do you mean by `not mentioned anywhere'? It's described
> > immediately before that: `with which the option *or argument* ...'.
> >
> > And why does it look `strange'? (At least not stranger than other
> > things I've written ;-)
> >
> 
> Erm ... granted. The problem is, you give two examples immediately
> followed by "In the first example ..." - and reader expects then "In the
> second example ...". And the whole paragraph stresses the _options_ case
> just casually mentioning _arguments_ (hence my confusion). So I suggest
> adding something like "In the second example the argument (which one?)
> won't be offered if option -foo is present"

Yep.

Bye
 Sven

Index: Doc/Zsh/compsys.yo
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Zsh/compsys.yo,v
retrieving revision 1.30
diff -u -r1.30 compsys.yo
--- Doc/Zsh/compsys.yo	2000/05/02 11:20:11	1.30
+++ Doc/Zsh/compsys.yo	2000/05/03 08:45:31
@@ -2921,11 +2921,13 @@
 `tt((-two -three 1)-one:...)' or `tt((-foo):...)'. In the first
 example, the options `tt(-two)' and `tt(-three)' and the first
 argument will not be offered as possible completions if the option
-`tt(-one)' is on the line before the cursor. Also, the list may
-contain a single star as one of its elements to specify that the
-description for the rest arguments should not be used and it may
-contain a colon to specify that the descriptions for all normal
-(non-option-) arguments should not be used.
+`tt(-one)' is on the line before the cursor and in the second example
+the argument described by the specification will not be offered if the
+option tt(-foo) is on the line. Also, the list may contain a single
+star as one of its elements to specify that the description for the
+rest arguments should not be used and it may contain a colon to
+specify that the descriptions for all normal (non-option-) arguments
+should not be used.
 
 In each of the cases above, the var(action) says how the possible
 completions should be generated. In cases where only one of a fixed

--
Sven Wischnowsky                         wischnow@xxxxxxxxxxxxxxxxxxxxxxx



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