summaryrefslogtreecommitdiff
path: root/lisp/newcomment.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2013-06-18 13:57:56 -0400
committerGlenn Morris <rgm@gnu.org>2013-06-18 13:57:56 -0400
commitdd7426eaf3aef63ac4671da9209187559cecc8ac (patch)
tree6eafe4acba5e6e4a5505c8a54befc77e43ca1d57 /lisp/newcomment.el
parent5ebb1ee6c92a14649d480db44a0c1a8b901369e4 (diff)
downloademacs-dd7426eaf3aef63ac4671da9209187559cecc8ac.tar.gz
* newcomment.el (comment-search-forward, comment-search-backward): Doc fix.
Diffstat (limited to 'lisp/newcomment.el')
-rw-r--r--lisp/newcomment.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/newcomment.el b/lisp/newcomment.el
index bcb5f721ae8..19a06bfe8e5 100644
--- a/lisp/newcomment.el
+++ b/lisp/newcomment.el
@@ -446,7 +446,9 @@ in strings will not confuse Emacs.")
"Find a comment start between point and LIMIT.
Moves point to inside the comment and returns the position of the
comment-starter. If no comment is found, moves point to LIMIT
-and raises an error or returns nil if NOERROR is non-nil."
+and raises an error or returns nil if NOERROR is non-nil.
+
+Ensure that `comment-normalize-vars' has been called before you use this."
(if (not comment-use-syntax)
(if (re-search-forward comment-start-skip limit noerror)
(or (match-end 1) (match-beginning 0))
@@ -484,7 +486,9 @@ and raises an error or returns nil if NOERROR is non-nil."
"Find a comment start between LIMIT and point.
Moves point to inside the comment and returns the position of the
comment-starter. If no comment is found, moves point to LIMIT
-and raises an error or returns nil if NOERROR is non-nil."
+and raises an error or returns nil if NOERROR is non-nil.
+
+Ensure that `comment-normalize-vars' has been called before you use this."
;; FIXME: If a comment-start appears inside a comment, we may erroneously
;; stop there. This can be rather bad in general, but since
;; comment-search-backward is only used to find the comment-column (in