]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify smie-indent-forward-token doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Thu, 12 Aug 2021 13:39:36 +0000 (15:39 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Thu, 12 Aug 2021 13:39:36 +0000 (15:39 +0200)
* lisp/emacs-lisp/smie.el (smie-indent-forward-token): Doc string
clarification (bug#31948).

lisp/emacs-lisp/smie.el

index ab3cb3c5ace730ba85cfaa7a03fddf2d1d6b03ab..d775f152b362b6f1540d8898b40dcfc414e1e71a 100644 (file)
@@ -1407,7 +1407,9 @@ BASE-POS is the position relative to which offsets should be applied."
     (funcall smie-rules-function method token)))
 
 (defun smie-indent-forward-token ()
-  "Skip token forward and return it, along with its levels."
+  "Skip token forward and return it, along with its levels.
+Point should be between tokens when calling this function (i.e.,
+not in the middle of a string/comment)."
   (let ((tok (funcall smie-forward-token-function)))
     (cond
      ((< 0 (length tok)) (assoc tok smie-grammar))