zsh-workers
 help / color / Atom feed
* [PATCH] docs: Change zstyle example to a non-hierarchical one
@ 2020-04-27 10:06 Daniel Shahaf
  0 siblings, 0 replies; only message in thread
From: Daniel Shahaf @ 2020-04-27 10:06 UTC (permalink / raw)
  To: zsh-workers

---
 Doc/Zsh/mod_zutil.yo | 23 +++++++++++++++--------
 Test/V05styles.ztst  | 13 +++++++++++++
 2 files changed, 28 insertions(+), 8 deletions(-)

diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo
index 812a1fd38..c69233f9d 100644
--- a/Doc/Zsh/mod_zutil.yo
+++ b/Doc/Zsh/mod_zutil.yo
@@ -32,20 +32,27 @@ If two patterns are equally specific, the tie is broken in favour of
 the pattern that was defined first.
 
 em(Example)
+kindex(preferred-precipitation, example style)
+findex(weather, example function)
 
-For example, to define your preferred form of precipitation depending on which
-city you're in, you might set the following in your tt(zshrc):
+For example, a fictional `tt(weather)' plugin might state in its documentation
+that it looks up the tt(preferred-precipitation) style under the
+`tt(:weather:)var(continent)tt(:)var(day-of-the-week)tt(:)var(phase-of-the-moon))' context.
+According to this, you might set the following in your tt(zshrc):
 
-example(zstyle ':weather:europe:*' preferred-precipitation rain
-zstyle ':weather:europe:germany:*' preferred-precipitation none
-zstyle ':weather:europe:germany:*:munich' preferred-precipitation snow)
+example(zstyle ':weather:*:Sunday:*' preferred-precipitation snow
+zstyle ':weather:europe:*' preferred-precipitation rain)
 
-Then, the fictional `tt(weather)' plugin might run under the hood a command
-such as
+Then the plugin would run under the hood a command such as
 
-example(zstyle -s ":weather:${continent}:${country}:${county}:${city}" preferred-precipitation REPLY)
+example(zstyle -s ":weather:${continent}:${day_of_week}:${moon_phase}" preferred-precipitation REPLY)
 
 in order to retrieve your preference into the scalar variable tt($REPLY).
+On Sundays tt($REPLY) would be set to `tt(snow)'; in Europe it would be set
+to `tt(rain)'; and on Sundays in Europe it would be set to `tt(snow)' again,
+because the patterns `tt(:weather:europe:*)' and `tt(:weather:*:Sunday:*)' both
+match the var(context) argument to tt(zstyle -s), are equally specific, and the
+latter was defined first.
 
 em(Usage)
 
diff --git a/Test/V05styles.ztst b/Test/V05styles.ztst
index c221d9db8..9b5fc4517 100644
--- a/Test/V05styles.ztst
+++ Test/V05styles.ztst
@@ -151,3 +151,16 @@
 >one
 >two
 
+ (
+  zstyle ':weather:*:Sunday:*' preferred-precipitation snow
+  zstyle ':weather:europe:*' preferred-precipitation rain
+  zstyle -s ':weather:europe:Sunday:foo' preferred-precipitation REPLY && print $REPLY
+ )
+ (
+  zstyle ':weather:europe:*' preferred-precipitation rain
+  zstyle ':weather:*:Sunday:*' preferred-precipitation snow
+  zstyle -s ':weather:europe:Sunday:foo' preferred-precipitation REPLY && print $REPLY
+ )
+0:the example in the documentation remains correct
+>snow
+>rain

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-27 10:06 [PATCH] docs: Change zstyle example to a non-hierarchical one Daniel Shahaf

zsh-workers

Archives are clonable: git clone --mirror http://inbox.vuxu.org/zsh-workers

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.archive.zsh.workers


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git