Skip to content

Commit 6d8a18a

Browse files
authored
DOC: More comments in PdfWriter (#2976)
Add two comments to the `__init__` of PdfWriter.
1 parent a6c9d36 commit 6d8a18a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

pypdf/_writer.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,13 @@ def __init__(
201201
dict[id(pdf)][(idnum, generation)]
202202
"""
203203

204-
self._ID: Union[ArrayObject, None] = None
205204
self._info_obj: Optional[PdfObject]
205+
"""The PDF files's document information dictionary,
206+
the Info entry in the PDF file's trailer dictionary."""
207+
208+
self._ID: Union[ArrayObject, None] = None
209+
"""The PDF file identifier,
210+
defined by the ID in the PDF file's trailer dictionary."""
206211

207212
if self.incremental:
208213
if isinstance(fileobj, (str, Path)):

0 commit comments

Comments
 (0)