From 105ca83aa2e8c16df4f83754f8b43f349032650c Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Sat, 21 Dec 2019 15:58:28 +0000 Subject: 45112: zshmodules: Explicitly document the return values of the 'zstyle' getters -s, -b, and -a. --- ChangeLog | 3 +++ Doc/Zsh/mod_zutil.yo | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/ChangeLog b/ChangeLog index bb283c3b7..4ae5cbbdf 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2019-12-22 Daniel Shahaf + * 45112: Doc/Zsh/mod_zutil.yo: zshmodules: Explicitly document + the return values of the 'zstyle' getters -s, -b, and -a. + * 45113: Doc/Zsh/contrib.yo: vcs_info docs: Clarify documentation of the %p/%u/%a patch-format expandos. diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo index fa1f7b3ea..1e35d2245 100644 --- a/Doc/Zsh/mod_zutil.yo +++ b/Doc/Zsh/mod_zutil.yo @@ -81,17 +81,23 @@ item(tt(zstyle -s) var(context) var(style) var(name) [ var(sep) ])( The parameter var(name) is set to the value of the style interpreted as a string. If the value contains several strings they are concatenated with spaces (or with the var(sep) string if that is given) between them. + +Return tt(0) if the style is set, tt(1) otherwise. ) item(tt(zstyle -b) var(context) var(style) var(name))( The value is stored in var(name) as a boolean, i.e. as the string `tt(yes)' if the value has only one string and that string is equal to one of `tt(yes)', `tt(true)', `tt(on)', or `tt(1)'. If the value is any other string or has more than one string, the parameter is set to `tt(no)'. + +Return tt(0) if var(name) is set to `tt(yes)', tt(1) otherwise. ) item(tt(zstyle -a) var(context) var(style) var(name))( The value is stored in var(name) as an array. If var(name) is declared as an associative array, the first, third, etc. strings are used as the keys and the other strings are used as the values. + +Return tt(0) if the style is set, tt(1) otherwise. ) xitem(tt(zstyle -t) var(context) var(style) [ var(string) ... ]) item(tt(zstyle -T) var(context) var(style) [ var(string) ... ])( -- cgit 1.4.1