about summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2016-07-17 14:57:28 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2016-07-17 14:58:05 +0000
commit18d676ff199d7ddc8c9ff3e18a4764ca1a4b25a4 (patch)
tree50f8213eb848ab9e97adbd0c9f79f3ba6334cd2a /Doc/Zsh
parentdb9f0d3b3e5f0211b50cdf422b99cffce8655d09 (diff)
downloadzsh-18d676ff199d7ddc8c9ff3e18a4764ca1a4b25a4.tar.gz
zsh-18d676ff199d7ddc8c9ff3e18a4764ca1a4b25a4.tar.xz
zsh-18d676ff199d7ddc8c9ff3e18a4764ca1a4b25a4.zip
users/21752: Extend zsh/zleparameter's $widgets' parameter's documentation.
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/mod_zleparameter.yo16
1 files changed, 9 insertions, 7 deletions
diff --git a/Doc/Zsh/mod_zleparameter.yo b/Doc/Zsh/mod_zleparameter.yo
index 03d504724..76d23ba2a 100644
--- a/Doc/Zsh/mod_zleparameter.yo
+++ b/Doc/Zsh/mod_zleparameter.yo
@@ -15,14 +15,16 @@ This array contains the names of the keymaps currently defined.
 )
 vindex(widgets)
 item(tt(widgets))(
-This associative array contains one entry per widget defined. The name 
+This associative array contains one entry per widget. The name 
 of the widget is the key and the value gives information about the
-widget. It is either the string `tt(builtin)' for builtin widgets, a
-string of the form `tt(user:)var(name)' for user-defined widgets,
-where var(name) is the name of the shell function implementing the
-widget, or it is a string of the form
-`tt(completion:)var(type)tt(:)var(name)', for completion widgets. In
-the last case var(type) is the name of the builtin widgets the
+widget. It is either
+  the string `tt(builtin)' for builtin widgets,
+  a string of the form `tt(user:)var(name)' for user-defined widgets,
+    where var(name) is the name of the shell function implementing the widget,
+  a string of the form `tt(completion:)var(type)tt(:)var(name)'
+    for completion widgets,
+  or a null value if the widget is not yet fully defined.
+In the penultimate case, var(type) is the name of the builtin widget the
 completion widget imitates in its behavior and var(name) is the name
 of the shell function implementing the completion widget.
 )