Change rendering of predicate types (#88)

I think this is clearer
pyodide · Sep 29, 2023 · 213a1c6 · 213a1c6
1 parent 1faf61f
commit 213a1c6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/sphinx_js/typedoc.py b/sphinx_js/typedoc.py
@@ -1165,9 +1165,10 @@ class PredicateType(TypeBase):
     targetType: "TypeD"
 
     def _render_name_root(self, converter: Converter) -> Iterator[str | ir.TypeXRef]:
-        yield self.name
-        yield " is "
+        yield ir.TypeXRefIntrinsic("boolean")
+        yield " (typeguard for "
         yield from self.targetType.render_name(converter)
+        yield ")"
 
 
 AnyNode = Node | Project | Signature

diff --git a/tests/test_build_ts/test_build_ts.py b/tests/test_build_ts/test_build_ts.py
@@ -185,7 +185,7 @@ def test_predicate(self):
                       * **c** (any) --
 
                    Returns:
-                      c is "ConstructorlessClass()"
+                      boolean (typeguard for "ConstructorlessClass()")
                 """
             ),
         )