PdfPage.flatten(): add note regarding invalidation of handles

pypdfium2-team · Sep 19, 2024 · d54d041 · d54d041
1 parent ef0854e
commit d54d041
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/pypdfium2/_helpers/page.py b/src/pypdfium2/_helpers/page.py
@@ -319,8 +319,8 @@ def flatten(self, flag=pdfium_c.FLAT_NORMALDISPLAY):
         Flatten form fields and annotations into page contents.
         
         Attention:
-            :meth:`~.PdfDocument.init_forms` must have been called on the parent pdf, before the page was retrieved, for this method to work.
-            In other words, :attr:`.PdfPage.formenv` must be non-null.
+            * :meth:`~.PdfDocument.init_forms` must have been called on the parent pdf, before the page was retrieved, for this method to work. In other words, :attr:`.PdfPage.formenv` must be non-null.
+            * Flattening may invalidate existing handles to the page, so you'll want to re-initialize them after flattening.
         
         Parameters:
             flag (int): PDFium flattening target (:attr:`FLAT_*`)