Merge pull request #169 from lpsinger/markdown-comments

Add comment characters for Markdown
scientific-python · Dec 9, 2021 · a75da2c · a75da2c
2 parents 713e0c2 + 6819b08
commit a75da2c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -3,6 +3,9 @@
 
 - Fix version check for pytest 7.0.0rc1. [#171]
 
+- Recognize text beginning with `<!--` as a comment for Markdown (`.md`) files.
+  [#169]
+
 0.11.1 (2021-11-16)
 ===================
 

diff --git a/pytest_doctestplus/plugin.py b/pytest_doctestplus/plugin.py
@@ -30,7 +30,8 @@
 comment_characters = {
     '.txt': '#',
     '.tex': '%',
-    '.rst': r'\.\.'
+    '.rst': r'\.\.',
+    '.md': '<!--'
 }
 
 

diff --git a/tests/test_doctestplus.py b/tests/test_doctestplus.py
@@ -522,17 +522,21 @@ def test_show_warnings_rst(testdir):
 
 def test_doctest_glob(testdir):
     testdir.makefile(
-        '.rst',
+        '.md',
         foo_1=">>> 1 + 1\n2",
     )
     testdir.makefile(
         '.rst',
         foo_2=">>> 1 + 1\n2",
     )
     testdir.makefile(
-        '.txt',
+        '.rst',
         foo_3=">>> 1 + 1\n2",
     )
+    testdir.makefile(
+        '.txt',
+        foo_4=">>> 1 + 1\n2",
+    )
     testdir.makefile(
         '.rst',
         bar_2=">>> 1 + 1\n2",
@@ -550,30 +554,42 @@ def test_doctest_glob(testdir):
     testdir.inline_run(
         '--doctest-plus', '--doctest-glob', '*.rst', '--doctest-glob', '*.txt'
     ).assertoutcome(passed=4)
+    testdir.inline_run(
+        '--doctest-plus', '--doctest-glob', '*.rst', '--doctest-glob', '*.txt',
+        '--doctest-glob', '*.md'
+    ).assertoutcome(passed=5)
     testdir.inline_run(
         '--doctest-plus', '--doctest-glob', 'foo_*.rst'
     ).assertoutcome(passed=2)
+    testdir.inline_run(
+        '--doctest-plus', '--doctest-glob', 'foo_*.md'
+    ).assertoutcome(passed=1)
     testdir.inline_run(
         '--doctest-plus', '--doctest-glob', 'foo_*.txt'
     ).assertoutcome(passed=1)
 
 
 def test_text_file_comments(testdir):
+    testdir.makefile(
+        '.md',
+        foo_1="<!-- >>> 1 + 1 -->\n3",
+    )
     testdir.makefile(
         '.rst',
-        foo_1=".. >>> 1 + 1\n3",
+        foo_2=".. >>> 1 + 1\n3",
     )
     testdir.makefile(
         '.tex',
-        foo_2="% >>> 1 + 1\n3",
+        foo_3="% >>> 1 + 1\n3",
     )
     testdir.makefile(
         '.txt',
-        foo_3="# >>> 1 + 1\n3",
+        foo_4="# >>> 1 + 1\n3",
     )
 
     testdir.inline_run(
         '--doctest-plus',
+        '--doctest-glob', '*.md',
         '--doctest-glob', '*.rst',
         '--doctest-glob', '*.tex',
         '--doctest-glob', '*.txt'