branch: elpa/guru-mode
commit 3274661e8e4b51455dfc8d8e08c64605463e62f2
Author: Bozhidar Batsov <bozhi...@batsov.com>
Commit: Bozhidar Batsov <bozhi...@batsov.com>
Add a docstring
---
guru-mode.el | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/guru-mode.el b/guru-mode.el
index 22ebebf..175c14f 100644
--- a/guru-mode.el
+++ b/guru-mode.el
@@ -4,7 +4,7 @@
;; Author: Bozhidar Batsov
;; URL: https://github.com/bbatsov/guru-mode
-;; Version: 0.2
+;; Version: 1.0
;; Keywords: convenience
;; This file is NOT part of GNU Emacs.
@@ -73,6 +73,10 @@
(prog2 (guru-mode -1) (key-binding (kbd key)) (guru-mode +1)))
(defun guru-rebind (original-key alt-key original-binding)
+ "Rebind ORIGINAL-KEY to a lambda.
+
+It will disable or warn and suggest using ALT-KEY for ORIGINAL-BINDING.
+The exact behavior of the lambda depends on the value of `guru-warn-only'."
(lambda ()
(interactive)
(let ((current-binding (guru-current-key-binding original-key)))
