branch: externals/inspector
commit fc9712651c27198032639735cd332803b0bf7ba4
Author: Mariano Montone <marianomont...@gmail.com>
Commit: Mariano Montone <marianomont...@gmail.com>
More complete package commentary
---
inspector.el | 26 ++++++++++++++++++++++++--
1 file changed, 24 insertions(+), 2 deletions(-)
diff --git a/inspector.el b/inspector.el
index 8d0adaec6b..0c78c042c7 100644
--- a/inspector.el
+++ b/inspector.el
@@ -22,8 +22,30 @@
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
-
-;; Tool for inspection of Emacs Lisp objects.
+;;;
+;;; Tool for inspection of Emacs Lisp objects.
+;;;
+;;; Usage:
+;;;
+;;; M-x `inspect-expression' to evaluate an elisp expression and inspect
the result.
+;;; M-x `inspect-last-sexp' to evaluate last sexp in current buffer and
inspect the result.
+;;;
+;;; Inside the inspector:
+;;;
+;;; M-x `inspector-pop' bound to letter l, to navigate to previous object.
+;;; M-x `inspector-quit' bound to letter q, to exit the inspector.
+;;;
+;;; Also, M-x `forward-button' and M-x `backward-button' are conveniently
bound to n and p.
+;;; They can be used for fast navigation across the buttons that the inspector
displays.
+;;;
+;;; Finally, you can use M-x `eval-expression' bound to letter e,
+;;; to evaluate an elisp expression using the object currently being inspected
(it is bound to *).
+;;;
+;;; From the Emacs debugger:
+;;;
+;;; When on an Emacs debugging backtrace, press letter i to inspect the
pointed frame and its local variables.
+;;;
+;;; When on edebug-mode, use C-c C-i for inspecting expressions in the
debugger.
;;; Code:
