From: Markus Triska <triska@metalevel.at>
Date: Mon, 27 Apr 2020 15:32:06 +0000 (+0200)
Subject: include usage advice about probabilistic predicates
X-Git-Tag: v0.8.123~102^2~1^2~3
X-Git-Url: https://git.sagredo.dev/?a=commitdiff_plain;h=7a2981e21cded69780c8215709fe4ac782ddad76;p=scryer-prolog.git

include usage advice about probabilistic predicates
---

diff --git a/src/prolog/lib/random.pl b/src/prolog/lib/random.pl
index 7e59fc23..5fee57e0 100644
--- a/src/prolog/lib/random.pl
+++ b/src/prolog/lib/random.pl
@@ -1,5 +1,11 @@
 :- module(random, [maybe/0, random/1, random_integer/3, set_random/1]).
 
+/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+   To retain desirable declarative properties, predicates that internally
+   use random numbers should be equipped with an argument that specifies
+   the random seed. This makes everything completely reproducible.
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
+
 % succeeds with probability 0.5.
 maybe :- '$maybe'.