From 8322b2b2018aa00100bd99ab7946d76787eed028 Mon Sep 17 00:00:00 2001 From: "Ryan M. Moore" Date: Wed, 3 May 2023 15:26:49 -0400 Subject: [PATCH] Add docs about seeding random generator --- src/Iter.mli | 6 +++++- src/IterLabels.mli | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/Iter.mli b/src/Iter.mli index 28be7a6..744fb25 100644 --- a/src/Iter.mli +++ b/src/Iter.mli @@ -705,7 +705,11 @@ module Map : sig module Make (V : Map.OrderedType) : S with type key = V.t end -(** {1 Random iterators} *) +(** {1 Random iterators} + + Random iterators use [Random.int], [Random.float], [Random.bool], + etc., under the hood, so they will respect seeding of the random + generator in the usual way. *) val random_int : int -> int t (** Infinite iterator of random integers between 0 and diff --git a/src/IterLabels.mli b/src/IterLabels.mli index 65a566b..6dad4ab 100644 --- a/src/IterLabels.mli +++ b/src/IterLabels.mli @@ -674,7 +674,11 @@ module Map : sig module Make (V : Map.OrderedType) : S with type key = V.t end -(** {2 Random iterators} *) +(** {2 Random iterators} + + Random iterators use [Random.int], [Random.float], [Random.bool], + etc., under the hood, so they will respect seeding of the random + generator in the usual way. *) val random_int : int -> int t (** Infinite iterator of random integers between 0 and