From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-1.0 required=5.0 tests=MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from primenet.com.au (ns1.primenet.com.au [203.24.36.2]) by inbox.vuxu.org (OpenSMTPD) with ESMTP id abb9beeb for ; Sat, 21 Dec 2019 15:59:29 +0000 (UTC) Received: (qmail 15989 invoked by alias); 21 Dec 2019 15:59:13 -0000 Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm Precedence: bulk X-No-Archive: yes List-Id: Zsh Workers List List-Post: List-Help: List-Unsubscribe: X-Seq: 45112 Received: (qmail 26868 invoked by uid 1010); 21 Dec 2019 15:59:13 -0000 X-Qmail-Scanner-Diagnostics: from out1-smtp.messagingengine.com by f.primenet.com.au (envelope-from , uid 7791) with qmail-scanner-2.11 (clamdscan: 0.102.1/25663. spamassassin: 3.4.2. Clear:RC:0(66.111.4.25):SA:0(-1.9/5.0):. Processed in 2.59432 secs); 21 Dec 2019 15:59:13 -0000 X-Envelope-From: danielsh@apache.org X-Qmail-Scanner-Mime-Attachments: | X-Qmail-Scanner-Zip-Files: | Received-SPF: softfail (ns1.primenet.com.au: transitioning SPF record at amazonses.com does not designate 66.111.4.25 as permitted sender) X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedufedrvdduhedgkedvucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucgogfeguddtqddvjeculdegtddmnecujfgurhephf fvufffkffojghfsedttdertdertddtnecuhfhrohhmpeffrghnihgvlhcuufhhrghhrghf uceouggrnhhivghlshhhsegrphgrtghhvgdrohhrgheqnecukfhppeejledrudektddrhe ejrdduudelnecurfgrrhgrmhepmhgrihhlfhhrohhmpegurghnihgvlhhshhesrghprggt hhgvrdhorhhgnecuvehluhhsthgvrhfuihiivgeptd X-ME-Proxy: From: Daniel Shahaf To: zsh-workers@zsh.org Subject: [PATCH 5/5] zshmodules: Explicitly document the return values of the 'zstyle' getters -s, -b, and -a. Date: Sat, 21 Dec 2019 15:58:28 +0000 Message-Id: <20191221155828.25950-5-danielsh@apache.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20191221155828.25950-1-danielsh@apache.org> References: <20191221155828.25950-1-danielsh@apache.org> --- Doc/Zsh/mod_zutil.yo | 6 ++++++ 1 file changed, 6 insertions(+) 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) ... ])(