Updating docs to show exclusive max

edjCase · Oct 2, 2024 · be6749c · be6749c
1 parent 24aed41
commit be6749c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/mops.toml b/mops.toml
@@ -3,10 +3,10 @@ base = "0.12.0"
 
 [package]
 name = "xtended-random"
-version = "1.0.0"
+version = "1.0.1"
 description = "A library for random helper funtions"
 repository = "https://github.com/edjcase/motoko_random"
-keywords = [ "random", "pseudo" ]
+keywords = [ "random", "pseudo", "rng" ]
 license = "MIT"
 
 [dev-dependencies]

diff --git a/src/PseudoRandomX.mo b/src/PseudoRandomX.mo
@@ -130,7 +130,7 @@ module {
             currentSeed;
         };
 
-        /// Generates a random integer within the specified range (exclusive).
+        /// Generates a random integer within the specified range (inclusive min, exclusive max).
         ///
         /// ```motoko include=import
         /// let prng : PseudoRandomGenerator = ...;
@@ -145,7 +145,7 @@ module {
             min + (Nat32.toNat(randNat32) % rangeSize);
         };
 
-        /// Generates a random natural number within the specified range (inclusive).
+        /// Generates a random natural number within the specified range (inclusive min, exclusive max).
         ///
         /// ```motoko include=import
         /// let prng : PseudoRandomGenerator = ...;

diff --git a/src/RandomX.mo b/src/RandomX.mo
@@ -63,7 +63,7 @@ module {
             ?(randValue <= trueCount);
         };
 
-        /// Generates a random integer within the specified range (inclusive).
+        /// Generates a random integer within the specified range (inclusive min, exclusive max).
         /// Returns null if there's not enough entropy.
         ///
         /// ```motoko include=import
@@ -89,7 +89,7 @@ module {
             ?randInt;
         };
 
-        /// Generates a random natural number within the specified range (inclusive).
+        /// Generates a random natural number within the specified range (inclusive min, exclusive max).
         /// Returns null if there's not enough entropy.
         ///
         /// ```motoko include=import