From 011be9f31dbd9e0420f4c2dd9655a374e2ccb94e Mon Sep 17 00:00:00 2001
From: Raphael Forment <raphael.forment@gmail.com>
Date: Mon, 28 Aug 2023 17:43:16 +0200
Subject: [PATCH] Documenting the rhythm function

---
 src/Documentation.ts | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/src/Documentation.ts b/src/Documentation.ts
index 0b463c2..60dc92b 100644
--- a/src/Documentation.ts
+++ b/src/Documentation.ts
@@ -366,7 +366,21 @@ mod(.25) && euclid($(4), 7, 9, 1) && snd('hh').out()
 )}
 
 
-	
+- <icode>rhythm(divisor: number, pulses: number, length: number, rotate: number): boolean</icode>: generates <icode>true</icode> or <icode>false</icode> values from an euclidian rhythm sequence. This is another version of <icode>euclid</icode> that does not take an iterator.
+${makeExample(
+"rhythm is a beginner friendly rhythmic function!",
+`
+let speed = [0.5, 0.25].div(8);
+rhythm(speed, 5, 12) :: snd('east').n(2).out()
+rhythm(speed, 2, 12) :: snd('east').out()
+rhythm(speed, 3, 12) :: snd('east').n(4).out()
+rhythm(speed, 7, 12) :: snd('east').n(9).out()
+`,
+  true
+)}
+
+
+
 - <icode>bin(iterator: number, n: number): boolean</icode>: a binary rhythm generator. It transforms the given number into its binary representation (_e.g_ <icode>34</icode> becomes <icode>100010</icode>). It then returns a boolean value based on the iterator in order to generate a rhythm.
 	
 ${makeExample(