From 2c528748eb91dcfffc9f8e0741fa1417a177cfdd Mon Sep 17 00:00:00 2001
From: Rylee Alanza Lyman <46907231+ryleelyman@users.noreply.github.com>
Date: Sun, 4 Dec 2022 11:32:15 -0500
Subject: [PATCH] fix: document sprocket ordering

---
 lua/lib/lattice.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lua/lib/lattice.lua b/lua/lib/lattice.lua
index 2ea06a04d..2977af178 100644
--- a/lua/lib/lattice.lua
+++ b/lua/lib/lattice.lua
@@ -133,6 +133,7 @@ end
 -- - "enabled" (boolean) is this sprocket enabled, defaults to true
 -- - "swing" (number) is the percentage of swing (0 - 100%), defaults to 50
 -- - "delay" (number) specifies amount of delay, as fraction of division (0.0 - 1.0), defaults to 0
+-- - "order" (number) specifies the place in line this lattice occupies from 1 to 5, lower first, defaults to 3
 -- @treturn table a new sprocket
 function Lattice:new_sprocket(args)
   self.sprocket_id_counter = self.sprocket_id_counter + 1
@@ -231,4 +232,4 @@ function Sprocket:set_delay(delay)
   self.delay_new = util.clamp(delay,0,1)
 end
 
-return Lattice
\ No newline at end of file
+return Lattice