Patch: Doc: clarify effect of KSH_ARRAYS on subscript (I)

Patch: Doc: clarify effect of KSH_ARRAYS on subscript (I)

[dg1727]

Hello,

Following is a Git diff of a proposed update to the documentation.

In future, if I have a small item like this to suggest, I intend to try to combine it with other small items so as not to make too much mailing-list traffic.  (I make no promises about this.)

This first minor update is just to try out the process.


    Doc: clarify effect of KSH_ARRAYS on subscript (I)

diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index 8daf33d5e..8682ec448 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -397,7 +397,9 @@ associative array.
 item(tt(I))(
 Like `tt(i)', but gives the index of the last match, or all possible
 matching keys in an associative array.  On failure substitutes 0, or
-the empty string for an associative array.  This flag is best when
+the empty string for an associative array.  If option tt(KSH_ARRAYS) is in
+effect and no match is found, the result is indistinguishable from the case
+when the first element of the array matches.  This flag is best when
 testing for values or keys that do not exist.
 )
 item(tt(k))(


Many thanks.

-dg1727

Re: Patch: Doc: clarify effect of KSH_ARRAYS on subscript (I)

[Daniel Shahaf]

dg1727 wrote on Tue, 07 Apr 2020 23:20 +0000:
> Hello,
> 
> Following is a Git diff of a proposed update to the documentation.
> 
> In future, if I have a small item like this to suggest, I intend to try to combine it with other small items so as not to make too much mailing-list traffic.  (I make no promises about this.)
> 
> This first minor update is just to try out the process.
> 
> 
>     Doc: clarify effect of KSH_ARRAYS on subscript (I)
> 
> diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
> index 8daf33d5e..8682ec448 100644
> --- a/Doc/Zsh/params.yo
> +++ b/Doc/Zsh/params.yo
> @@ -397,7 +397,9 @@ associative array.
>  item(tt(I))(
>  Like `tt(i)', but gives the index of the last match, or all possible
>  matching keys in an associative array.  On failure substitutes 0, or
> -the empty string for an associative array.  This flag is best when
> +the empty string for an associative array.  If option tt(KSH_ARRAYS) is in
> +effect and no match is found, the result is indistinguishable from the case
> +when the first element of the array matches.  This flag is best when
>  testing for values or keys that do not exist.
>  )
>  item(tt(k))(
> 
> 
> Many thanks.

Thanks for the patch!  I've applied it with minor changes.  (I've been
AFK all week or I'd have done so sooner)

Cheers,

Daniel