From b8423f0ed1a96891a2380d2436f6d929ea37c504 Mon Sep 17 00:00:00 2001
From: Aria <weglossing@gmail.com>
Date: Sun, 24 Aug 2025 12:01:12 -0500
Subject: [PATCH] Add docstring

---
 packages/core/signal.mjs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/packages/core/signal.mjs b/packages/core/signal.mjs
index 91901f86c..78755bd98 100644
--- a/packages/core/signal.mjs
+++ b/packages/core/signal.mjs
@@ -240,6 +240,17 @@ const __timeToRands = (t, n) => __timeToRandsPrime(__timeToIntSeed(t), n);
 // End old random
 
 let useOldRandomBool = false;
+/**
+ * Whether to use the old random number generator or not. Can be used to support legacy projects
+ *
+ * @name useOldRandom
+ * @param {boolean} b - Whether to use old RNG
+ * @example
+ * useOldRandom(true)
+ * // Repeats every 300 cycles
+ * $: n(irand(50)).seg(16).scale("C:minor").ribbon(88, 32)._punchcard()
+ * $: n(irand(50)).seg(16).scale("C:minor").ribbon(388, 32)._punchcard()
+ */
 export const useOldRandom = (b = true) => useOldRandomBool = b;
 
 // N samples at time t