master 368c9f5 3/4: Clarify smie-indent-forward-token doc string

[Lars Ingebrigtsen]

branch: master
commit 368c9f5e8499849587296c49f7f2b28ca4dc5fd9
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Clarify smie-indent-forward-token doc string
    
    * lisp/emacs-lisp/smie.el (smie-indent-forward-token): Doc string
    clarification (bug#31948).
---
 lisp/emacs-lisp/smie.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lisp/emacs-lisp/smie.el b/lisp/emacs-lisp/smie.el
index ab3cb3c..d775f15 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))