emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [elpa] externals/inspector fc9712651c 36/39: More complete package c


From: Stefan Monnier
Subject: Re: [elpa] externals/inspector fc9712651c 36/39: More complete package commentary
Date: Sat, 10 Sep 2022 18:08:41 -0400
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)

Side note:

> -;; 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.

By convention, three semi-colons (and more) is used for (sub)section headers,
so in order for your file to be conveniently browsable with
`outline-minor-mode`, please use only two semi-colons in long comments
as above.


        Stefan




reply via email to

[Prev in Thread] Current Thread [Next in Thread]