Change appearance to normal_appearance for clarity

typst · Feb 11, 2024 · 38ffdb0 · 38ffdb0
1 parent ee99ce9
commit 38ffdb0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/examples/video.rs b/examples/video.rs
@@ -120,7 +120,7 @@ fn main() -> std::io::Result<()> {
     annotation.subtype(AnnotationType::Screen);
     annotation.rect(bbox);
     annotation.page(page_id);
-    annotation.appearance(form_xobject_id);
+    annotation.normal_appearance(form_xobject_id);
 
     // Write a rendition action for the screen annotation.
     let mut action = annotation.action();

diff --git a/src/annotations.rs b/src/annotations.rs
@@ -43,11 +43,11 @@ impl<'a> Annotation<'a> {
         self
     }
 
-    /// Write the `/AP` dictionary to provide the visual appearance for a screen
-    /// annotation. For now, this sets only the normal appearance as a reference
-    /// to a [`FormXObject`]. Only permissible for the subtype `Screen`.
-    /// PDF 1.5+.
-    pub fn appearance(&mut self, id: Ref) -> &mut Self {
+    /// Write the `/N` attribute inside the `/AP` dictionary to provide the
+    /// visual appearance for a screen annotation. For now, this sets only the
+    /// normal appearance as a reference to a [`FormXObject`]. Only permissible
+    /// for the subtype `Screen`. PDF 1.5+.
+    pub fn normal_appearance(&mut self, id: Ref) -> &mut Self {
         self.insert(Name(b"AP")).dict()
                                 .pair(Name(b"N"), id);
         self