about summary refs log tree commit diff
path: root/Doc/Zsh/compsys.yo
diff options
context:
space:
mode:
authorOliver Kiddle <opk@users.sourceforge.net>2003-09-21 16:13:53 +0000
committerOliver Kiddle <opk@users.sourceforge.net>2003-09-21 16:13:53 +0000
commit5de758139453d13db577e957a3b09ea08dd8aaa8 (patch)
tree916ff2dce8f598c5f4cea2fceff3eb05f10871ea /Doc/Zsh/compsys.yo
parent239872c578a701da7fa80b03c481e561f8c640d5 (diff)
downloadzsh-5de758139453d13db577e957a3b09ea08dd8aaa8.tar.gz
zsh-5de758139453d13db577e957a3b09ea08dd8aaa8.tar.xz
zsh-5de758139453d13db577e957a3b09ea08dd8aaa8.zip
19106: document use for _menu
Diffstat (limited to 'Doc/Zsh/compsys.yo')
-rw-r--r--Doc/Zsh/compsys.yo13
1 files changed, 7 insertions, 6 deletions
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 6b77fb8f8..9322f61c3 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -2784,12 +2784,13 @@ not be used.
 )
 findex(_menu)
 item(tt(_menu))(
-This completer is a simple example function implemented to show how
-menu completion can be done in shell code.  It should be used as the
-first completer and has the effect of making later completers perform
-menu completion.  Note that this is independent of the setting of the
-tt(MENU_COMPLETE) option and does not work with the other
-menu completion widgets such as tt(reverse-menu-complete), or
+This completer was written as simple example function to show how menu
+completion can be enabled in shell code. However, it has the notable
+effect of disabling menu selection which can be useful with
+tt(_generic) based widgets. It should be used as the first completer in
+the list.  Note that this is independent of the setting of the
+tt(MENU_COMPLETE) option and does not work with the other menu
+completion widgets such as tt(reverse-menu-complete), or
 tt(accept-and-menu-complete).
 )
 findex(_oldlist)