Browse Source

Add documentation for `indium-inspect-expression'

workspaces
Nicolas Petton 3 years ago
parent
commit
0bb43ddcf0
Signed by: nico GPG Key ID: 233587A47C207910
2 changed files with 14 additions and 10 deletions
  1. +13
    -10
      doc/Indium.texi
  2. +1
    -0
      sphinx-doc/code-evaluation.rst

+ 13
- 10
doc/Indium.texi View File

@ -21,7 +21,7 @@
@copying
@quotation
Indium 0.7.1, Aug 18, 2017
Indium 0.7.1, Aug 19, 2017
Nicolas Petton
@ -244,7 +244,7 @@ Add the following to your Emacs configuration:
@end menu
@node NodeJS,Chrome/Chromium,,Getting up and running
@anchor{setup id1}@anchor{a}@anchor{setup nodejs}@anchor{b}
@anchor{setup nodejs}@anchor{a}@anchor{setup id1}@anchor{b}
@subsection NodeJS
@ -407,7 +407,7 @@ directory!
@end cartouche
@node The REPL,Interaction in JS buffers,Getting up and running,Table of contents
@anchor{repl doc}@anchor{13}@anchor{repl the-repl}@anchor{14}@anchor{repl repl}@anchor{15}
@anchor{repl repl}@anchor{13}@anchor{repl the-repl}@anchor{14}@anchor{repl doc}@anchor{15}
@section The REPL
@ -558,7 +558,7 @@ the current stack frame, and will be able to access local variables from the
stack, etc.
@node Interaction in JS buffers,The stepping debugger,The REPL,Table of contents
@anchor{code-evaluation doc}@anchor{1c}@anchor{code-evaluation interaction}@anchor{1d}@anchor{code-evaluation interaction-in-js-buffers}@anchor{1e}
@anchor{code-evaluation interaction-in-js-buffers}@anchor{1c}@anchor{code-evaluation doc}@anchor{1d}@anchor{code-evaluation interaction}@anchor{1e}
@section Interaction in JS buffers
@ -602,6 +602,9 @@ Here’s a list of available keybindings:
@code{C-c M-i}: Inspect the result of the evaluation of an expression (see
@ref{17,,The inspector}).
@item
@code{C-c M-:}: Prompt for an expression to evaluate and inspect.
@item
@code{M-x indium-eval-buffer}: Evaluate the entire buffer.
@end itemize
@ -612,7 +615,7 @@ Here’s a list of available keybindings:
Press @code{C-c C-z} from any buffer with @code{indium-interaction-mode} turned on to
switch back to the REPL buffer (see @ref{15,,The REPL}).
switch back to the REPL buffer (see @ref{13,,The REPL}).
@node Adding and removing breakpoints,Live code update hot-swapping JavaScript sources,Switching to the REPL buffer,Interaction in JS buffers
@anchor{code-evaluation adding-and-removing-breakpoints}@anchor{21}
@ -709,7 +712,7 @@ window.addEventListener("patch", (event) => @{
@end example
@node The stepping debugger,The inspector,Interaction in JS buffers,Table of contents
@anchor{debugger debugger}@anchor{22}@anchor{debugger doc}@anchor{25}@anchor{debugger the-stepping-debugger}@anchor{26}
@anchor{debugger the-stepping-debugger}@anchor{25}@anchor{debugger debugger}@anchor{22}@anchor{debugger doc}@anchor{26}
@section The stepping debugger
@ -719,7 +722,7 @@ window.addEventListener("patch", (event) => @{
@end menu
@node Using sourcemaps,,,The stepping debugger
@anchor{debugger using-sourcemaps}@anchor{27}@anchor{debugger sourcemaps}@anchor{23}
@anchor{debugger sourcemaps}@anchor{23}@anchor{debugger using-sourcemaps}@anchor{27}
@subsection Using sourcemaps
@ -738,13 +741,13 @@ supported, inlined sourcemaps are not yet supported.
@end cartouche
@node The inspector,Network,The stepping debugger,Table of contents
@anchor{inspector doc}@anchor{28}@anchor{inspector inspector}@anchor{17}@anchor{inspector the-inspector}@anchor{29}
@anchor{inspector the-inspector}@anchor{28}@anchor{inspector inspector}@anchor{17}@anchor{inspector doc}@anchor{29}
@section The inspector
Indium features an object inspector that can be open on any object reference
from a REPL buffer (see @ref{15,,The REPL}), the debugger (see @ref{22,,The stepping debugger}), or
the result of any evaluation of JavaScript code (see @ref{1d,,Interaction in JS buffers}).
from a REPL buffer (see @ref{13,,The REPL}), the debugger (see @ref{22,,The stepping debugger}), or
the result of any evaluation of JavaScript code (see @ref{1e,,Interaction in JS buffers}).
To inspect the result of the evaluation of an expression, press @code{C-c M-i}. An
inspector buffer will pop up. You can also press @code{RET} or left click on


+ 1
- 0
sphinx-doc/code-evaluation.rst View File

@ -22,6 +22,7 @@ Here's a list of available keybindings:
- ``C-M-x``: Evaluate the innermost function enclosing the point.
- ``C-c M-i``: Inspect the result of the evaluation of an expression (see
:ref:`inspector`).
- ``C-c M-:``: Prompt for an expression to evaluate and inspect.
- ``M-x indium-eval-buffer``: Evaluate the entire buffer.
Switching to the REPL buffer


Loading…
Cancel
Save