Skip to content

Commit

Permalink
docs(Logger): tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia committed Sep 24, 2023
1 parent c637afe commit f1b5531
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/LoggerSigs.ml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module type S =
sig
module Code : Diagnostic.Code

(** {2 Sending Diagnostics} *)
(** {2 Sending Messages} *)

(** [emit code str] emits a string and continues the computation.
Expand Down Expand Up @@ -112,7 +112,9 @@ sig
(** [merge_loc loc f] "merges" [loc] into the current location and runs the thunk [f]. By "merge", it means that if [loc] is [None], then the current location is kept; otherwise, it is overwritten. Note that [with_loc None] will clear the current location, while [merge_loc None] will keep it. See {!val:with_loc}. *)
val merge_loc : Span.t option -> (unit -> 'a) -> 'a

(** {2 Constructing Diagnostics with Current Backtraces} *)
(** {2 Constructing Diagnostics} *)

(** Functions in this section differ from the ones in {!module:Diagnostic} (for example, {!val:Diagnostic.make}) in that they fill out the current location, the current backtrace, and the severity automatically. (One can still overwrite them with optional arguments.) *)

(** [diagnostic code str] constructs a diagnostic with the message [str] along with the backtrace frames recorded via {!val:tracef}.
Expand Down

0 comments on commit f1b5531

Please sign in to comment.