diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2021-08-12 15:39:36 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2021-08-12 15:39:36 +0200 |
commit | 368c9f5e8499849587296c49f7f2b28ca4dc5fd9 (patch) | |
tree | 210a53a6c81775295a407272f49dceb582e908cd | |
parent | 7328a6ea10d812aa1a1033cb355c870707521e7a (diff) | |
download | emacs-368c9f5e8499849587296c49f7f2b28ca4dc5fd9.tar.gz |
Clarify smie-indent-forward-token doc string
* lisp/emacs-lisp/smie.el (smie-indent-forward-token): Doc string
clarification (bug#31948).
-rw-r--r-- | lisp/emacs-lisp/smie.el | 4 |
1 files changed, 3 insertions, 1 deletions
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)) |