From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Thu, 12 Aug 2021 13:39:36 +0000 (+0200)
Subject: Clarify smie-indent-forward-token doc string
X-Git-Tag: emacs-28.0.90~1540
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=368c9f5e8499849587296c49f7f2b28ca4dc5fd9;p=emacs.git

Clarify smie-indent-forward-token doc string

* lisp/emacs-lisp/smie.el (smie-indent-forward-token): Doc string
clarification (bug#31948).
---

diff --git a/lisp/emacs-lisp/smie.el b/lisp/emacs-lisp/smie.el
index ab3cb3c5ace..d775f152b36 100644
--- a/lisp/emacs-lisp/smie.el
+++ b/lisp/emacs-lisp/smie.el
@@ -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))