diff options
Diffstat (limited to 'use-package-bind-key.el')
| -rw-r--r-- | use-package-bind-key.el | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/use-package-bind-key.el b/use-package-bind-key.el index 75def7f..4ebf548 100644 --- a/use-package-bind-key.el +++ b/use-package-bind-key.el @@ -5,18 +5,20 @@ ;; Author: John Wiegley <johnw@newartisans.com> ;; Maintainer: John Wiegley <johnw@newartisans.com> -;; This program is free software; you can redistribute it and/or modify +;; This file is part of GNU Emacs. + +;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. -;; This program is distributed in the hope that it will be useful, +;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with this program. If not, see <https://www.gnu.org/licenses/>. +;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. ;;; Commentary: @@ -24,6 +26,10 @@ ;; keywords. Note that these are currently still baked into ;; `use-package-keywords' and `use-package-deferring-keywords', although this ;; is harmless if they are never used. +;; +;; These keywords are made available by default by requiring `use-package'. +;; +;; See the `use-package' info manual for more information. ;;; Code: @@ -32,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)) |