summaryrefslogtreecommitdiff
path: root/cider-debug.el
diff options
context:
space:
mode:
authorArtur Malabarba <bruce.connor.am@gmail.com>2015-12-16 23:20:13 +0000
committerArtur Malabarba <bruce.connor.am@gmail.com>2016-01-15 23:46:10 +0000
commitd968a741da8732d48664244cde9a41f1c9f0788c (patch)
treeaf846ee49ba586dd44a2ede433c158722a49ca14 /cider-debug.el
parentbfd519d498e93c8a8b2c466e11f877939aa17131 (diff)
Fix docstring for cider--debug-move-point
Diffstat (limited to 'cider-debug.el')
-rw-r--r--cider-debug.el10
1 files changed, 5 insertions, 5 deletions
diff --git a/cider-debug.el b/cider-debug.el
index 17a27989..e1c99da5 100644
--- a/cider-debug.el
+++ b/cider-debug.el
@@ -423,14 +423,14 @@ REASON is a keyword describing why this buffer was necessary."
limit 'noerror)))
(defun cider--debug-move-point (coordinates)
- "Place point on POS in FILE, then navigate into the next sexp.
+ "Place point on after the sexp specified by COORDINATES.
COORDINATES is a list of integers that specify how to navigate into the
-sexp.
+sexp that is after point when this function is called.
As an example, a COORDINATES list of '(1 0 2) means:
- - enter this sexp and move forward once,
- - enter this sexp,
- - enter this sexp and move forward twice.
+ - enter next sexp then `forward-sexp' once,
+ - enter next sexp,
+ - enter next sexp then `forward-sexp' twice.
In the following snippet, this takes us to the (* x 2) sexp (point is left
at the end of the given sexp).