More format doc cleanups

lenskit · Dec 19, 2023 · 62d6ea0 · 62d6ea0
1 parent 7786ddc
commit 62d6ea0
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/binpickle/format.py b/binpickle/format.py
@@ -141,7 +141,13 @@ def encode(self):
 
     @classmethod
     def decode(cls, buf: bytes | bytearray | memoryview, *, verify: bool = True) -> FileTrailer:
-        "Decode a file trailer from bytes."
+        """
+        Decode a file trailer from bytes.
+
+        Args:
+            buf: Buffer containing the trailer to decode.
+            verify: Whether to verify invalid trailer data (currently ignored).
+        """
         off, len, ck = TRAILER_FORMAT.unpack(buf)
         return cls(off, len, ck)