diff options
author | Stefan Kangas <stefankangas@gmail.com> | 2022-12-09 06:55:48 +0100 |
---|---|---|
committer | Stefan Kangas <stefankangas@gmail.com> | 2022-12-09 06:55:48 +0100 |
commit | 58a483960dd3e8807cf0df2a865f8b4cda22f784 (patch) | |
tree | 0cd4851a8b0245493c6296852fad25778f99aa5d /lisp/use-package | |
parent | 5b640f0abd3f83449e8780ce8060eb723574986b (diff) | |
download | emacs-58a483960dd3e8807cf0df2a865f8b4cda22f784.tar.gz emacs-58a483960dd3e8807cf0df2a865f8b4cda22f784.tar.bz2 emacs-58a483960dd3e8807cf0df2a865f8b4cda22f784.zip |
; Improve use-package-autoload-keymap docstring
* lisp/use-package/use-package-bind-key.el
(use-package-autoload-keymap): Improve docstring.
Diffstat (limited to 'lisp/use-package')
-rw-r--r-- | lisp/use-package/use-package-bind-key.el | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/lisp/use-package/use-package-bind-key.el b/lisp/use-package/use-package-bind-key.el index 44242c9e01d..4ebf54825c6 100644 --- a/lisp/use-package/use-package-bind-key.el +++ b/lisp/use-package/use-package-bind-key.el @@ -38,15 +38,14 @@ ;;;###autoload (defun use-package-autoload-keymap (keymap-symbol package override) - "Loads PACKAGE and then binds the key sequence used to invoke -this function to KEYMAP-SYMBOL. It then simulates pressing the -same key sequence a again, so that the next key pressed is routed -to the newly loaded keymap. + "Load PACKAGE and bind key sequence invoking this function to KEYMAP-SYMBOL. +Then simulate pressing the same key sequence a again, so that the +next key pressed is routed to the newly loaded keymap. -This function supports use-package's :bind-keymap keyword. It +This function supports use-package's :bind-keymap keyword. It works by binding the given key sequence to an invocation of this -function for a particular keymap. The keymap is expected to be -defined by the package. In this way, loading the package is +function for a particular keymap. The keymap is expected to be +defined by the package. In this way, loading the package is deferred until the prefix key sequence is pressed." (if (not (require package nil t)) (use-package-error (format "Cannot load package.el: %s" package)) |