Add note to options.pdfa

typst · Sep 30, 2024 · b01b745 · b01b745
1 parent 2641470
commit b01b745
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -156,7 +156,11 @@ pub struct ConversionOptions {
     /// _Default:_ `true`.
     pub embed_text: bool,
 
-    /// Whether to enforce PDF/A rules.
+    /// Whether to write chunks in PDF/A-2b compliant mode.
+    ///
+    /// **Note:** This currently only ensures that `to_chunk` does not generate
+    /// anything that is forbidden by PDF/A. It does _not_ turn the
+    /// free-standing PDF generated by `to_pdf` into a valid PDF/A.
     pub pdfa: bool,
 }