branch: externals/inspector
commit 2808124fcc27d1757a828a84a79658ce9b6ae9b7
Author: Kristoffer Balintona <[email protected]>
Commit: Kristoffer Balintona <[email protected]>
Better document `inspector-inspect-defun`
---
README.md | 1 +
inspector.el | 7 ++++---
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index df3bcfed85..8f6fd5645d 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@ This package is available from ELPA.
* `M-x inspector-inspect-expression` to evaluate an elisp expression and
inspect the result.
* `M-x inspector-inspect-last-sexp` to evaluate last sexp in current buffer
and inspect the result.
+* `M-x inspector-inspect-defun` to evaluate the top-level defun at point at
inspect the result.
### Inside the inspector
diff --git a/inspector.el b/inspector.el
index ba04c73eef..840f4cfeff 100644
--- a/inspector.el
+++ b/inspector.el
@@ -29,6 +29,7 @@
;;
;; M-x `inspector-inspect-expression' to evaluate an elisp expression and
inspect the result.
;; M-x `inspector-inspect-last-sexp' to evaluate last sexp in current
buffer and inspect the result.
+;; M-x `inspector-inspect-defun' to evaluate the top-level defun at point
at inspect the result.
;;
;; Inside the inspector:
;;
@@ -895,8 +896,8 @@ When PRESERVE-HISTORY is T, inspector history is not
cleared."
;;;###autoload
(defun inspector-inspect-defun ()
- "Evaluate the top s-exp - simmilar the effect
- of M-x or eval-defun and inspect the result"
+ "Evaluate the top-level defun at point and inspect the result.
+This has a similar purpose to \\[eval-defun]."
(interactive)
(let* ((s-exp (read
(save-excursion
@@ -995,7 +996,7 @@ When PRESERVE-HISTORY is T, inspector history is not
cleared."
;;;###autoload
(defun inspector-inspect-in-stack-frame (exp)
- "Inspect an expression, in an environment like that outside the debugger.
+ "Inspect expression EXP in an environment like that outside the debugger.
The environment used is the one when entering the activation frame at point."
(interactive
(list (read--expression "Inspect in stack frame: ")))
