branch: externals/inspector
commit eb764736a512b8c9976c9f61e953569afeb515f2
Merge: 0c02fd712f 2808124fcc
Author: Mariano Montone <[email protected]>
Commit: GitHub <[email protected]>

    Merge pull request #37 from krisbalintona/push-xwxxrsvurvxk
    
    Minor documentation improvements
---
 README.md    |  1 +
 inspector.el | 12 ++++++++----
 2 files changed, 9 insertions(+), 4 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 29f4a79861..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:
 ;;
@@ -193,7 +194,10 @@ The target width is given by the `pp-max-width' variable."
   :group 'inspector)
 
 (defcustom inspector-switch-to-buffer t
-  "Use `switch-to-buffer-other-window' after an inspector buffer is opened."
+  "Use `switch-to-buffer-other-window' after an inspector buffer is opened.
+Otherwise, when nil, use `display-buffer' to display inspector buffers.
+
+This option applies to *inspector* and *inspector pprint* buffers."
   :type 'boolean
   :group 'inspector)
 
@@ -892,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
@@ -992,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: ")))

Reply via email to