Skip to content

Commit

Permalink
users/21752: Extend zsh/zleparameter's $widgets' parameter's document…
Browse files Browse the repository at this point in the history
…ation.
  • Loading branch information
danielshahaf committed Jul 17, 2016
1 parent db9f0d3 commit 18d676f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
3 changes: 3 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
2016-07-17 Daniel Shahaf <d.s@daniel.shahaf.name>

* users/21752: Doc/Zsh/mod_zleparameter.yo: Extend
zsh/zleparameter's $widgets' parameter's documentation.

* unposted (cf. users/21737):: Completion/Unix/Command/_git:
_git-subtree: Record technical debt in comment.

Expand Down
16 changes: 9 additions & 7 deletions Doc/Zsh/mod_zleparameter.yo
Original file line number Diff line number Diff line change
Expand Up @@ -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.
)
Expand Down

0 comments on commit 18d676f

Please sign in to comment.