package alcotest

  1. Overview
  2. Docs
package alcotest
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Pp.MakeSource

Parameters

module _ : sig ... end

Signature

Sourcetype event = [
  1. | `Result of Alcotest_engine__.Model.Test_name.t * [ `Ok | `Exn of Alcotest_engine__.Model.Test_name.t * string * unit Fmt.t | `Error of Alcotest_engine__.Model.Test_name.t * unit Fmt.t | `Skip | `Todo of string ]
  2. | `Start of Alcotest_engine__.Model.Test_name.t
]
Sourcetype result = {
  1. success : int;
  2. failures : int;
  3. time : float;
  4. errors : unit Fmt.t list;
}
Sourceval info : ?available_width:int -> max_label:int -> doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) -> Alcotest_engine__.Model.Test_name.t Fmt.t
Sourceval rresult_error : [ `Ok | `Exn of Alcotest_engine__.Model.Test_name.t * string * unit Fmt.t | `Error of Alcotest_engine__.Model.Test_name.t * unit Fmt.t | `Skip | `Todo of string ] Fmt.t
Sourceval event_line : margins:int -> max_label:int -> doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) -> [ `Result of Alcotest_engine__.Model.Test_name.t * [< Alcotest_engine__.Model.Run_result.t ] | `Start of Alcotest_engine__.Model.Test_name.t ] Fmt.t
Sourceval event : isatty:bool -> compact:bool -> max_label:int -> doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) -> selector_on_failure:bool -> tests_so_far:int -> event Fmt.t
Sourceval suite_results : log_dir:(Format.formatter -> unit) -> < verbose : bool ; show_errors : bool ; json : bool ; compact : bool.. > -> result Fmt.t
Sourceval quoted : 'a Fmt.t -> 'a Fmt.t

Wraps a formatter with `GNU-style quotation marks'.

Sourceval with_surrounding_box : 'a Fmt.t -> 'a Fmt.t

Wraps a formatter with a Unicode box with width given by _.stdout_columns. Uses box-drawing characters from code page 437.

Sourceval horizontal_rule : _ Fmt.t

Horizontal rule of length _.stdout_columns. Uses box-drawing characters from code page 437.

Sourceval user_error : string -> _

Raise a user error, then fail.

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