branch: externals/inspector commit 6f47c95ea2a6bda81babba126a66a32a7d2ac457 Author: Mariano Montone <marianomont...@gmail.com> Commit: Mariano Montone <marianomont...@gmail.com>
README --- README.md | 27 +++++++++++++++++++++++++++ inspector.el | 4 ++-- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md new file mode 100644 index 0000000000..5c50e76001 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# EMACS-INSPECTOR + +## Overview + +Inspector tool for Emacs Lisp objects. + +Similar to inspectors available for Smalltalk and Common Lisp, but for Emacs Lisp. + +## Installation + +This is work in progress at the moment. Just download and load the file into Emacs for now. + +## Usage + +### Invocation + +`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. + +### From the Emacs debugger + +When on an Emacs debugging backtrace, use `M-x debugger-inspect-locals` to inspect the local variable values of the pointed frame. diff --git a/inspector.el b/inspector.el index e4a8dd6a2e..14b0e0430b 100644 --- a/inspector.el +++ b/inspector.el @@ -1,4 +1,4 @@ -;;; inspector.el --- Emacs Lisp objects inspector. -*- lexical-binding: t -*- +;;; inspector.el --- Tool for inspection of Emacs Lisp objects. -*- lexical-binding: t -*- ;; Copyright (C) 2021 Mariano Montone @@ -23,7 +23,7 @@ ;;; Commentary: -;; Emacs Lisp objects inspector. +;; Tool for inspection of Emacs Lisp objects. ;;; Code: