MAINT: Update comment

Recursive types like the following are now supported by mypy: OutlineType = List[Union[Destination, "OutlineType"]] However, this recursuve type does not work with the Sphinx documentation generator; update comment to reflect this.
py-pdf · Mar 5, 2025 · 9b36297 · 9b36297
1 parent b7fd19a
commit 9b36297
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/pypdf/types.py b/pypdf/types.py
@@ -24,7 +24,10 @@
 ZoomArgType: TypeAlias = Union[NumberObject, NullObject, float]
 ZoomArgsType: TypeAlias = List[ZoomArgType]
 
-OutlineType: TypeAlias = List[Union[Destination, "OutlineType"]]
+# Recursive types like the following are not yet supported by Sphinx:
+#    OutlineType = List[Union[Destination, "OutlineType"]]
+# Hence use this for the moment:
+OutlineType = List[Union[Destination, List[Union[Destination, List[Destination]]]]]
 
 LayoutType: TypeAlias = Literal[
     "/NoLayout",