[BUGFIX] Multiline comments may contain empty lines

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#comments
phpDocumentor · Mar 2, 2024 · 5af7e1c · 5af7e1c
1 parent 3aa4eb9
commit 5af7e1c
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 8 deletions.
diff --git a/packages/guides-restructured-text/src/RestructuredText/Parser/Productions/CommentRule.php b/packages/guides-restructured-text/src/RestructuredText/Parser/Productions/CommentRule.php
@@ -56,11 +56,11 @@ private function isCommentLine(string|null $line): bool
             return false;
         }
 
-        return $this->isComment($line) || (trim($line) !== '' && $line[0] === ' ');
+        return $this->isComment($line) || trim($line) === '' || $line[0] === ' ';
     }
 
     private function isComment(string $line): bool
     {
-        return trim($line) === '..' || preg_match('/^\.\.\s+.*$/mUsi', $line) > 0;
+        return trim($line) === '..' || preg_match('/^\.\.\s+[^:]*$/mUsi', $line) > 0;
     }
 }
diff --git a/tests/Functional/tests/comment-empty/comment-empty.html b/tests/Functional/tests/comment-empty/comment-empty.html
@@ -1,4 +1 @@
 <p>this is not a comment</p>
-<blockquote>
-    <p>this is a blockquote</p>
-</blockquote>
diff --git a/tests/Integration/tests/class/class-directive/expected/index.html b/tests/Integration/tests/class/class-directive/expected/index.html
@@ -20,8 +20,6 @@ <h1>Document title</h1>
         <p>A note without a class</p>
 </div>
 
-            <blockquote class="highlights"><p>Block quote text.</p></blockquote>
-
     </div>
 
 <!-- content end -->
diff --git a/tests/Integration/tests/class/class-directive/input/index.rst b/tests/Integration/tests/class/class-directive/input/index.rst
@@ -37,4 +37,4 @@ Document title
 
 ..
 
-    Block quote text.
+    This is a comment
diff --git a/tests/Integration/tests/comments/comment-multiline/expected/index.html b/tests/Integration/tests/comments/comment-multiline/expected/index.html
@@ -0,0 +1,8 @@
+<!-- content start -->
+    <div class="section" id="some-title">
+            <h1>Some Title</h1>
+
+            <p>This text is no comment</p>
+    </div>
+
+<!-- content end -->
diff --git a/tests/Integration/tests/comments/comment-multiline/input/index.rst b/tests/Integration/tests/comments/comment-multiline/input/index.rst
@@ -0,0 +1,10 @@
+Some Title
+==========
+
+..
+   This whole indented block
+   is a comment.
+
+   Still in the comment.
+
+This text is no comment
diff --git a/tests/Integration/tests/comments/comment-nested/expected/index.html b/tests/Integration/tests/comments/comment-nested/expected/index.html
@@ -0,0 +1,12 @@
+<!-- content start -->
+    <div class="section" id="some-title">
+            <h1>Some Title</h1>
+
+            <div class="admonition note">
+            <p>No comment!</p><p>This text is no comment</p>
+</div>
+
+            <p>After the node</p>
+    </div>
+
+<!-- content end -->
diff --git a/tests/Integration/tests/comments/comment-nested/input/index.rst b/tests/Integration/tests/comments/comment-nested/input/index.rst
@@ -0,0 +1,15 @@
+Some Title
+==========
+
+..  note::
+    No comment!
+
+    ..
+       This whole indented block
+       is a comment.
+
+       Still in the comment.
+
+    This text is no comment
+
+After the node