Skip to content

Commit 224d369

Browse files
authored
Merge pull request #233 from jmid/fix-exception-doc
Fix exception documentation
2 parents 1eb6f16 + ab751cb commit 224d369

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/core/QCheck2.mli

+6-6
Original file line numberDiff line numberDiff line change
@@ -1701,8 +1701,8 @@ module Test : sig
17011701
val check_result : 'a cell -> 'a TestResult.t -> unit
17021702
(** [check_result cell res] checks that [res] is [Ok _], and returns unit.
17031703
Otherwise, it raises some exception.
1704-
@raise Test_error if [res = Error _]
1705-
@raise Test_error if [res = Failed _] *)
1704+
@raise Test_fail if [res = Failed _]
1705+
@raise Test_error if [res = Error _] *)
17061706

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

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

17631763
(** {2 Sub-tests} *)

0 commit comments

Comments
 (0)