gazagnaire.org
Find and remove dead code and unused APIs in OCaml projects
1(** Progress display utilities for terminal output using the Progress library *)
2
3type t
4(** Abstract type for progress state *)
5
6val pp : Format.formatter -> t -> unit
7(** [pp fmt t] pretty-prints progress information. *)
8
9val v : total:int -> t
10(** [v ~total] creates a new progress indicator with a progress bar. If [total]
11 is 0 or the output is not a terminal, creates a no-op progress indicator. *)
12
13val update : t -> current:int -> string -> unit
14(** [update progress ~current message] updates the progress display with the
15 current count and message. The progress bar shows percentage, elapsed time,
16 and the message. *)
17
18val clear : t -> unit
19(** [clear progress] finalizes and clears the progress display. *)