DOC: More comments in PdfWriter (#2976)

Add two comments to the `__init__` of PdfWriter.
py-pdf · Dec 2, 2024 · 6d8a18a · 6d8a18a
1 parent a6c9d36
commit 6d8a18a
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/pypdf/_writer.py b/pypdf/_writer.py
@@ -201,8 +201,13 @@ def __init__(
            dict[id(pdf)][(idnum, generation)]
         """
 
-        self._ID: Union[ArrayObject, None] = None
         self._info_obj: Optional[PdfObject]
+        """The PDF files's document information dictionary,
+        the Info entry in the PDF file's trailer dictionary."""
+
+        self._ID: Union[ArrayObject, None] = None
+        """The PDF file identifier,
+        defined by the ID in the PDF file's trailer dictionary."""
 
         if self.incremental:
             if isinstance(fileobj, (str, Path)):