Insert description for attachments

pikepdf · Apr 29, 2022 · 1e9a947 · 1e9a947
1 parent b4725d6
commit 1e9a947
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/topics/attachments.rst b/docs/topics/attachments.rst
@@ -17,7 +17,10 @@ to one of its test files.
 
     In [1]: pdf = Pdf.open('../tests/resources/fourpages.pdf')
 
-    In [1]: filespec = AttachedFileSpec.from_filepath(pdf, Path('../README.md'))
+    In [1]: filespec = AttachedFileSpec.from_filepath(
+       ...:     pdf,
+       ...:     Path('../README.md'),
+       ...:     description='This is the file description')
 
     In [1]: pdf.attachments['README.md'] = filespec
 
@@ -104,6 +107,7 @@ prompt the user to view the attached document. Valid icons and their relative si
      ...:     Name=Name.PushPin,
      ...:     FS=filespec.obj,
      ...:     Rect=icon_location,
+     ...:     Contents='This is the file description',
      ...: )
 
   In [1]: pdf.pages[0].Annots = pdf.make_indirect(Array([