masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-05 03:39:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

; Improve use-package-autoload-keymap docstring

Browse source 
* lisp/use-package/use-package-bind-key.el
(use-package-autoload-keymap): Improve docstring.
This commit is contained in:
Stefan Kangas 2022-12-09 06:55:48 +01:00
parent 5b640f0abd
commit 58a483960d
1 changed files with 6 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
lisp/use-package/use-package-bind-key.el
View file

@ -38,15 +38,14 @@
;;;###autoload ;;;###autoload
(defun use-package-autoload-keymap (keymap-symbol package override) (defun use-package-autoload-keymap (keymap-symbol package override)
"Loads PACKAGE and then binds the key sequence used to invoke "Load PACKAGE and bind key sequence invoking this function to KEYMAP-SYMBOL.
this function to KEYMAP-SYMBOL. It then simulates pressing the Then simulate pressing the same key sequence a again, so that the
same key sequence a again, so that the next key pressed is routed next key pressed is routed to the newly loaded keymap.
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 works by binding the given key sequence to an invocation of this
function for a particular keymap. The keymap is expected to be function for a particular keymap. The keymap is expected to be
defined by the package. In this way, loading the package is defined by the package. In this way, loading the package is
deferred until the prefix key sequence is pressed." deferred until the prefix key sequence is pressed."
(if (not (require package nil t)) (if (not (require package nil t))
(use-package-error (format "Cannot load package.el: %s" package)) (use-package-error (format "Cannot load package.el: %s" package))