fix: emit a warning when no content is rendered

Fixes pypa#149 Signed-off-by: Mike Fiedler <[email protected]>
miketheman · Mar 23, 2022 · 0889c59 · 0889c59
1 parent 7512742
commit 0889c59
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/readme_renderer/rst.py b/readme_renderer/rst.py
@@ -129,4 +129,5 @@ def render(
     if rendered:
         return clean(rendered)
     else:
+        stream.write("no output rendered")
         return None
diff --git a/tests/test_rst.py b/tests/test_rst.py
@@ -53,3 +53,13 @@ def test_rst_raw():
 """, stream=warnings) is None
 
     assert '"raw" directive disabled' in warnings.getvalue()
+
+
+def test_rst_header_only():
+    warnings = io.StringIO()
+    assert render("""
+Header
+======
+""", stream=warnings) is None
+
+    assert "no output rendered" in warnings.getvalue()