branch: externals/tex-parens
commit 1ef410b16c2484b468c1131eb421845380f21c3d
Author: Paul Nelson <[email protected]>
Commit: Paul Nelson <[email protected]>
clarify docstring of tp--ignore
---
tex-parens.el | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/tex-parens.el b/tex-parens.el
index f88d283d04..aaffe32517 100644
--- a/tex-parens.el
+++ b/tex-parens.el
@@ -255,12 +255,12 @@ defun-based commands."
(defun tp--ignore (m-str m-begin m-end)
"Check if M-STR should be ignored.
-M-STR is the string matched by the search, M-BEGIN is the
-beginning of the match, and M-END is the end of the match. If
-TP-IGNORE-COMMENTS is non-nil, then ignore comments. If M-STR is
-a double prime in math mode, then ignore it. If M-STR is a
-dollar delimiter that does not demarcate math mode, then ignore
-it."
+M-STR is the string matched by the search, while M-BEGIN and
+M-END delimit the match. If `tp-ignore-comments' is non-nil,
+then ignore comments; these are detected via
+`font-lock-comment-face'. If M-STR is a double prime in math
+mode, then ignore it. If M-STR is a dollar delimiter that does
+not demarcate math mode, then ignore it."
(or
(and
tp-ignore-comments
