Skip to content

Commit 472ba94

Browse files
committed
Clarify int*/nat* generator documentation
1 parent b37c72c commit 472ba94

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

src/core/QCheck.mli

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -318,10 +318,10 @@ module Gen : sig
318318
@since 0.23 *)
319319

320320
val nat : int t
321-
(** Generates small natural numbers. *)
321+
(** Generates small natural numbers ([0] included). *)
322322

323323
val int_pos_mid : int t
324-
(** Generates small natural numbers.
324+
(** Generates small natural numbers ([0] included).
325325
Synonym for {!nat}.
326326
@since 0.90 *)
327327

@@ -330,21 +330,22 @@ module Gen : sig
330330
@since 0.90 *)
331331

332332
val int_pos : int t
333-
(** Generates non-strictly positive integers uniformly (0 included).
333+
(** Generates positive integers uniformly (0 included).
334334
@since 0.90 *)
335335

336-
val int : int t (** Generates integers uniformly. *)
336+
val int : int t
337+
(** Generates integers uniformly. *)
337338

338339
val int_small : int t
339-
(** Generated small signed integers.
340+
(** Generates small signed integers.
340341
@since 0.90 *)
341342

342343
val int_pos_small : int t
343-
(** Small integers (< 100)
344+
(** Generates small positive integers (< 100, [0] included)
344345
@since 0.90 *)
345346

346347
val nat_small : int t
347-
(** Small integers (< 100)
348+
(** Generates small positive integers (< 100, [0] included)
348349
Synonym for {!int_pos_small}.
349350
@since 0.90 *)
350351

@@ -1182,35 +1183,35 @@ val exponential : float -> float arbitrary
11821183
@since 0.23 *)
11831184

11841185
val int : int arbitrary
1185-
(** Int generator. Uniformly distributed. *)
1186+
(** Generates integers uniformly. *)
11861187

11871188
val int_bound : int -> int arbitrary
1188-
(** [int_bound n] is uniform between [0] and [n] included. *)
1189+
(** [int_bound n] generates integers uniformly between [0] and [n] included. *)
11891190

11901191
val int_range : int -> int -> int arbitrary
1191-
(** [int_range a b] is uniform between [a] and [b] included. [b] must be
1192-
larger than [a]. *)
1192+
(** [int_range a b] generates integers uniformly between [a] and [b] included.
1193+
[b] must be larger than [a]. *)
11931194

11941195
val int_small : int arbitrary
11951196
(** Generates small signed integers.
11961197
@since 0.90 *)
11971198

11981199
val nat : int arbitrary
1199-
(** Generates natural numbers (< [10_000]).
1200+
(** Generates small natural numbers (< [10_000], [0] included).
12001201
Non-uniform: smaller numbers are more likely than bigger numbers.
12011202
@since 0.90 *)
12021203

12031204
val int_pos_small : int arbitrary
1204-
(** Small unsigned integers.
1205+
(** Generates small positive integers ([0] included).
12051206
@since 0.90 *)
12061207

12071208
val int_pos_mid : int arbitrary
1208-
(** Generates natural numbers (< [10_000]).
1209+
(** Generates small natural numbers (< [10_000], [0] included).
12091210
Synonym for {!nat}.
12101211
@since 0.90 *)
12111212

12121213
val nat_small : int arbitrary
1213-
(** Small unsigned integers.
1214+
(** Generates small positive integers ([0] included).
12141215
Synonym for {!int_pos_small}.
12151216
@since 0.90 *)
12161217

src/core/QCheck2.mli

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,14 +186,14 @@ module Gen : sig
186186
@since 0.90 *)
187187

188188
val int_pos : int t
189-
(** Generates non-strictly positive integers uniformly ([0] included).
189+
(** Generates positive integers uniformly ([0] included).
190190
191191
Shrinks towards towards [0].
192192
193193
@since 0.90 *)
194194

195195
val int_pos_small : int t
196-
(** Small positive integers (< [100], [0] included).
196+
(** Generates small positive integers (< [100], [0] included).
197197
198198
Non-uniform: smaller numbers are more likely than bigger numbers.
199199
@@ -202,22 +202,22 @@ module Gen : sig
202202
@since 0.90 *)
203203

204204
val nat_small : int t
205-
(** Small positive integers (< [100], [0] included).
205+
(** Generates small positive integers (< [100], [0] included).
206206
207207
Synonym for {!int_pos_small}.
208208
209209
@since 0.90 *)
210210

211211
val nat : int t
212-
(** Generates natural numbers (< [10_000]).
212+
(** Generates natural numbers (< [10_000], [0] included).
213213
214214
Non-uniform: smaller numbers are more likely than bigger numbers.
215215
216216
Shrinks towards [0].
217217
*)
218218

219219
val int_pos_mid : int t
220-
(** Generates natural numbers (< [10_000]).
220+
(** Generates natural numbers (< [10_000], [0] included).
221221
222222
Synonym for {!nat}.
223223

0 commit comments

Comments
 (0)