Skip to content

Commit 18d676f

Browse files
committed
users/21752: Extend zsh/zleparameter's $widgets' parameter's documentation.
1 parent db9f0d3 commit 18d676f

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

ChangeLog

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
2016-07-17 Daniel Shahaf <[email protected]>
22

3+
* users/21752: Doc/Zsh/mod_zleparameter.yo: Extend
4+
zsh/zleparameter's $widgets' parameter's documentation.
5+
36
* unposted (cf. users/21737):: Completion/Unix/Command/_git:
47
_git-subtree: Record technical debt in comment.
58

Doc/Zsh/mod_zleparameter.yo

+9-7
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,16 @@ This array contains the names of the keymaps currently defined.
1515
)
1616
vindex(widgets)
1717
item(tt(widgets))(
18-
This associative array contains one entry per widget defined. The name
18+
This associative array contains one entry per widget. The name
1919
of the widget is the key and the value gives information about the
20-
widget. It is either the string `tt(builtin)' for builtin widgets, a
21-
string of the form `tt(user:)var(name)' for user-defined widgets,
22-
where var(name) is the name of the shell function implementing the
23-
widget, or it is a string of the form
24-
`tt(completion:)var(type)tt(:)var(name)', for completion widgets. In
25-
the last case var(type) is the name of the builtin widgets the
20+
widget. It is either
21+
the string `tt(builtin)' for builtin widgets,
22+
a string of the form `tt(user:)var(name)' for user-defined widgets,
23+
where var(name) is the name of the shell function implementing the widget,
24+
a string of the form `tt(completion:)var(type)tt(:)var(name)'
25+
for completion widgets,
26+
or a null value if the widget is not yet fully defined.
27+
In the penultimate case, var(type) is the name of the builtin widget the
2628
completion widget imitates in its behavior and var(name) is the name
2729
of the shell function implementing the completion widget.
2830
)

0 commit comments

Comments
 (0)