fix: Don't escape signatures return annotations

pawamoy · pawamoy · commit ac54bfc57613 · 2022-02-24T21:40:46.000+01:00
Issue mkdocstrings#6: mkdocstrings#6
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/signature.html b/src/mkdocstrings_handlers/python/templates/material/_base/signature.html
@@ -38,7 +38,7 @@
         {%- endif -%}
       {%- endfor -%}
     )
-    {%- if config.show_signature_annotations and function.annotation %} -> {{ function.annotation }}{%- endif -%}
+    {%- if config.show_signature_annotations and function.annotation %} -> {{ function.annotation|safe }}{%- endif -%}
 
   {%- endwith -%}
 {%- endif -%}
diff --git a/tests/test_renderer.py b/tests/test_renderer.py
@@ -31,3 +31,15 @@ def test_render_docstring_examples_section(renderer):
     assert "<p>This is an example.</p>" in rendered
     assert "print" in rendered
     assert "Hello" in rendered
+
+
+def test_format_code_and_signature(renderer):
+    """Assert code and signatures can be Black-formatted.
+
+    Parameters:
+        renderer: A renderer instance (parametrized).
+    """
+    assert renderer.do_format_code("print('Hello')", 100)
+    assert renderer.do_format_code('print("Hello")', 100)
+    assert renderer.do_format_signature("(param: str = 'hello') -> 'Class'", 100)
+    assert renderer.do_format_signature('(param: str = "hello") -> "Class"', 100)

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`{%- endif -%}`
`39`	`39`	`{%- endfor -%}`
`40`	`40`	`)`
`41`		`- {%- if config.show_signature_annotations and function.annotation %} -> {{ function.annotation }}{%- endif -%}`
	`41`	`+ {%- if config.show_signature_annotations and function.annotation %} -> {{ function.annotation\|safe }}{%- endif -%}`
`42`	`42`
`43`	`43`	`{%- endwith -%}`
`44`	`44`	`{%- endif -%}`