Document Tar.fold

mirage · May 9, 2024 · b1c10d0 · b1c10d0
1 parent 576dcff
commit b1c10d0
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/tar.mli b/lib/tar.mli
@@ -206,3 +206,6 @@ val return : ('a, 'err) result -> ('a, 'err, _) t
 type ('a, 'err, 't) fold = (?global:Header.Extended.t -> Header.t -> 'a -> ('a, 'err, 't) t) -> 'a -> ('a, 'err, 't) t
 
 val fold : ('a, [> `Fatal of error ], 't) fold
+(** [fold f] is a [_ t] that reads an archive and executes [f] on each header.
+    [f] is expected to either read or skip the file contents, or return an
+    error. *)