File 5551-Update-after-feedback.patch of Package erlang
From ee2cad7a3adc97b9d1b8c62013ba6a23cd97c9b8 Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Wed, 6 Apr 2022 15:30:31 +0200
Subject: [PATCH 11/11] Update after feedback
---
lib/stdlib/doc/src/rand.xml | 24 ++++++++++++++++++++----
1 file changed, 20 insertions(+), 4 deletions(-)
diff --git a/lib/stdlib/doc/src/rand.xml b/lib/stdlib/doc/src/rand.xml
index 262964aca9..8bd6e56364 100644
--- a/lib/stdlib/doc/src/rand.xml
+++ b/lib/stdlib/doc/src/rand.xml
@@ -58,6 +58,20 @@
roughly equivalent to one regular iteration per generator bit.
</p>
+ <p>
+ At the end of this module documentation there are also some
+ <seeerl marker="#niche_algorithms">
+ niche algorithms
+ </seeerl>
+ to be used without this module's normal
+ <seeerl marker="#plug_in_api">
+ plug-in framework API
+ </seeerl>
+ that may be useful for special purposes like
+ short generation time when quality is not essential,
+ for seeding other generators, and such.
+ </p>
+
<p>
<marker id="algorithms"/>
The following algorithms are provided:
@@ -407,6 +421,7 @@ tests. We suggest to use a sign test to extract a random Boolean value.</pre>
<funcs>
<fsdescription>
+ <marker id="plug_in_api"/>
<title>Plug-in framework API</title>
</fsdescription>
<func>
@@ -793,6 +808,7 @@ end.</pre>
<funcs>
<fsdescription>
+ <marker id="niche_algorithms"/>
<title>Niche algorithms API</title>
</fsdescription>
<func>
@@ -878,8 +894,8 @@ end.</pre>
<fsummary>Return a new generator state / number.</fsummary>
<desc>
<p>
- Returns a new generator state which is also
- the generated number, <c><anno>X1</anno></c>,
+ Returns a generated Pseudo Random Number which is also
+ the new generated state, <c><anno>X1</anno></c>,
according to a classical Multiplicative Congruential Generator
(a.k.a Multiplicative Linear Congruential Generator,
Lehmer random number generator,
@@ -929,8 +945,8 @@ end.</pre>
<fsummary>Return a new generator state / number.</fsummary>
<desc>
<p>
- Returns a new generator state which is also
- the generated number, <c><anno>X1</anno></c>,
+ Returns a generated Pseudo Random Number which is also
+ the new generated state, <c><anno>X1</anno></c>,
according to a classical Linear Congruential Generator,
a power of 2 mixed congruential generator.
</p>
--
2.34.1