summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2020-03-19 01:54:38 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2020-03-20 02:28:11 +0000
commit68d2a1bc2235a8b88399252e801025b663d6e9be (patch)
tree1fcb1f57dfdf11a3e660dc1d9efdefde6fb1e2cc
parent65f8e90f0d0eccf12f73d717439016d8db872622 (diff)
downloadzsh-68d2a1bc2235a8b88399252e801025b663d6e9be.tar.gz
zsh-68d2a1bc2235a8b88399252e801025b663d6e9be.zip
unposted: ${(Z)}: Convert documentation to a description block.
-rw-r--r--ChangeLog3
-rw-r--r--Doc/Zsh/expn.yo21
2 files changed, 20 insertions, 4 deletions
diff --git a/ChangeLog b/ChangeLog
index 26b60e7e5..6a7bbfdc2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
2020-03-20 Daniel Shahaf <d.s@daniel.shahaf.name>
+ * unposted: Doc/Zsh/expn.yo: ${(Z)}: Convert documentation to
+ a description block.
+
* unposted: Util/ztst-syntax.vim: internal: ztst.vim: Make
sure syntax elements are only hidden if they're followed by
something visible
diff --git a/Doc/Zsh/expn.yo b/Doc/Zsh/expn.yo
index c129b4228..2a66ab997 100644
--- a/Doc/Zsh/expn.yo
+++ b/Doc/Zsh/expn.yo
@@ -1377,16 +1377,29 @@ i.e. tt("${(@s.:.)line}").
item(tt(Z:)var(opts)tt(:))(
As tt(z) but takes a combination of option letters between a following
pair of delimiter characters. With no options the effect is identical
-to tt(z). tt(LPAR()Z+PLUS()c+PLUS()RPAR())
+to tt(z). The following options are available:
+
+startitem()
+item(tt(LPAR()Z+PLUS()c+PLUS()RPAR()))(
causes comments to be parsed as a string and retained; any field in the
resulting array beginning with an unquoted comment character is a
-comment. tt(LPAR()Z+PLUS()C+PLUS()RPAR()) causes comments to be parsed
+comment.
+)
+item(tt(LPAR()Z+PLUS()C+PLUS()RPAR()))(
+causes comments to be parsed
and removed. The rule for comments is standard: anything between a word
starting with the third character of tt($HISTCHARS), default tt(#), up to
-the next newline is a comment. tt(LPAR()Z+PLUS()n+PLUS()RPAR()) causes
+the next newline is a comment.
+)
+item(tt(LPAR()Z+PLUS()n+PLUS()RPAR()))(
+causes
unquoted newlines to be treated as ordinary whitespace, else they are
treated as if they are shell code delimiters and converted to
-semicolons. Options are combined within the same set of delimiters,
+semicolons.
+)
+enditem()
+
+Options are combined within the same set of delimiters,
e.g. tt(LPAR()Z+PLUS()Cn+PLUS()RPAR()).
)
item(tt(_:)var(flags)tt(:))(