package dolmen_loop

  1. Overview
  2. Docs

Module Report.WarningSource

Sourcetype 'a t = 'a warning

The type of warnings, parameterized by their payload/parameters.

Sourceval code : _ t -> Code.t

Return the return code of an error.

Sourceval name : _ t -> string

Return the name (short description) of a warning.

Sourceval mnemonic : _ t -> string

Return the mnemonic of a warning.

Sourceval print : Format.formatter -> ('a t * 'a) -> unit

Print a warning.

Sourceval print_hints : Format.formatter -> ('a t * 'a) -> unit

Print an warning's hints.

Sourceval print_doc : Format.formatter -> _ t -> unit

Print the (long) documentation of a warning.

Sourceval mk : ?code:Code.t -> mnemonic:string -> message:(Format.formatter -> 'a -> unit) -> ?hints:('a -> (Format.formatter -> unit) option) list -> name:string -> ?doc:(Format.formatter -> unit) -> unit -> 'a t

Create a new warning.

Sourcemodule Status : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct