Skip to content

Fix exception documentation #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmid merged 1 commit into from
Apr 4, 2022
Merged

Fix exception documentation #233

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/core/QCheck2.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1701,8 +1701,8 @@ module Test : sig
val check_result : 'a cell -> 'a TestResult.t -> unit
(** [check_result cell res] checks that [res] is [Ok _], and returns unit.
Otherwise, it raises some exception.
@raise Test_error if [res = Error _]
@raise Test_error if [res = Failed _] *)
@raise Test_fail if [res = Failed _]
@raise Test_error if [res = Error _] *)

type res =
| Success
Expand Down Expand Up @@ -1750,14 +1750,14 @@ module Test : sig
?step:'a step -> ?handler:'a handler ->
?rand:Random.State.t -> 'a cell -> unit
(** Same as {!check_cell} but calls {!check_result} on the result.
@raise Test_error if [res = Error _]
@raise Test_error if [res = Failed _] *)
@raise Test_fail if [res = Failed _]
@raise Test_error if [res = Error _] *)

val check_exn : ?long:bool -> ?rand:Random.State.t -> t -> unit
(** Checks the property against some test cases, and calls {!check_result},
which might raise an exception in case of failure.
@raise Test_error if [res = Error _]
@raise Test_error if [res = Failed _] *)
@raise Test_fail if [res = Failed _]
@raise Test_error if [res = Error _] *)
end

(** {2 Sub-tests} *)
Expand Down