# HG changeset patch
# User Richard M. Stallman <rms@gnu.org>
# Date 1006685865 0
# Node ID 026c44f1505434e453c46ab677112ca9e0fb7293
# Parent  9c2a7409da96281b694173af5be9700f535998f7
Clarify behavior of forward-comment.

diff -r 9c2a7409da96 -r 026c44f15054 lispref/syntax.texi
--- a/lispref/syntax.texi	Sun Nov 25 10:09:09 2001 +0000
+++ b/lispref/syntax.texi	Sun Nov 25 10:57:45 2001 +0000
@@ -769,10 +769,18 @@
 one comment or several comments.
 
 @defun forward-comment count
-This function moves point forward across @var{count} comments (backward,
-if @var{count} is negative).  If it finds anything other than a comment
-or whitespace, it stops, leaving point at the place where it stopped.
-It also stops after satisfying @var{count}.
+This function moves point forward across @var{count} complete comments
+(that is, including the starting delimiter and the terminating
+delimiter if any).  It moves backward if @var{count} is negative.  If
+it encounters anything other than a comment or whitespace, it stops,
+leaving point at the place where it stopped.  This includes (for
+instance) finding the end of a comment when moving forward and
+expecting the beginning of one.  The function also stops immediately
+after moving over the specified number of complete comments.
+
+This function cannot tell whether the ``comments'' it traverses are
+embedded within a string.  If they look like comments, it treats them
+as comments.
 @end defun
 
 To move forward over all comments and whitespace following point, use