branch: master
commit 159f0f9b78753574a1892ae3e47c8c1938965ea9
Author: Justin Burkett <[email protected]>
Commit: Justin Burkett <[email protected]>
Add notes about paging commands not working with minibuffer
---
README.org | 4 +++-
which-key.el | 5 ++++-
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index 9ad7cb1..edde2a4 100644
--- a/README.org
+++ b/README.org
@@ -118,7 +118,9 @@
[[./img/which-key-minibuffer.png]]
Note the maximum height of the minibuffer is controlled through the
built-in
- variable =max-mini-window-height=.
+ variable =max-mini-window-height=. Also, the paging commands do not work
+ reliably with the minibuffer option. Use the side window on the bottom
+ option if you need paging.
** Additional Commands
- =which-key-show-top-level= will show most key bindings without a prefix.
It
diff --git a/which-key.el b/which-key.el
index 348f50d..79f7aff 100644
--- a/which-key.el
+++ b/which-key.el
@@ -778,7 +778,10 @@ bottom."
;;;###autoload
(defun which-key-setup-minibuffer ()
- "Apply suggested settings for minibuffer."
+ "Apply suggested settings for minibuffer.
+Do not use this setup if you use the paging commands. Instead use
+`which-key-setup-side-window-bottom', which is nearly identical
+but more functional."
(interactive)
(which-key--setup-echo-keystrokes)
(setq which-key-popup-type 'minibuffer
