add missing space on required args in markdown

lincolnloop · Feb 10, 2024 · 59467fb · 59467fb
1 parent a93ab42
commit 59467fb
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -2,6 +2,11 @@
 Change Log
 ==========
 
+Unreleased
+==========
+
+- Another markdown output fix
+
 4.0.1 (10 February 2024)
 ========================
 

diff --git a/goodconf/__init__.py b/goodconf/__init__.py
@@ -260,7 +260,7 @@ def generate_markdown(cls) -> str:
         for k, v in cls.__fields__.items():
             lines.append(f"* **{k}**")
             if v.required:
-                lines[-1] = lines[-1] + "_REQUIRED_"
+                lines[-1] = lines[-1] + " _REQUIRED_"
             if v.field_info.description:
                 lines.append(f"  * description: {v.field_info.description}")
             lines.append(f"  * type: `{type_to_str(v.outer_type_)}`")

diff --git a/tests/test_goodconf.py b/tests/test_goodconf.py
@@ -154,6 +154,13 @@ class TestConf(GoodConf):
     assert "  * type: `Literal['a', 'b']`" in lines
     assert "  * type: `list[str]`" in lines
 
+def test_generate_markdown_required():
+    class TestConf(GoodConf):
+        a: str
+
+    lines = TestConf.generate_markdown().splitlines()
+    assert "* **a** _REQUIRED_" in lines
+
 
 def test_undefined():
     c = GoodConf()