Add docstring

vojtechpavlu · May 25, 2024 · 9394dcf · 9394dcf
1 parent f0689d9
commit 9394dcf
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/utils/random/randomizer.ts b/src/utils/random/randomizer.ts
@@ -57,6 +57,10 @@ export const useRandomizer = (name: RandomizerName): void => {
   RANDOMIZER = getRandomizer(name);
 };
 
+/**
+ * Implementation of Linear congruential generator to enable
+ * seeding the pseudo-randomization.
+ */
 export const useSeed = (seed: number): void => {
   RANDOMIZER = () => {
     seed = (seed * 9301 + 49297) % 233280;