From 61f6337f5fc13a5142361cccea8d4994e6962ef3 Mon Sep 17 00:00:00 2001
From: sammyette <torchedsammy@gmail.com>
Date: Wed, 28 Dec 2022 19:32:52 -0400
Subject: [PATCH] docs: improve docs for timers interface

---
 docs/timers.md  | 39 +--------------------------------------
 timerhandler.go | 27 ++++++++++++++++++++++++---
 2 files changed, 25 insertions(+), 41 deletions(-)

diff --git a/docs/timers.md b/docs/timers.md
index 0f89718..1b9c602 100644
--- a/docs/timers.md
+++ b/docs/timers.md
@@ -1,38 +1 @@
-If you ever want to run a piece of code on a timed interval, or want to wait
-a few seconds, you don't have to rely on timing tricks, as Hilbish has a
-timer API to set intervals and timeouts.
-
-These are the simple functions `hilbish.interval` and `hilbish.timeout` (doc
-accessible with `doc hilbish`). But if you want slightly more control over
-them, there is the `hilbish.timers` interface. It allows you to get
-a timer via ID.
-
-# Timer Interface
-## Functions
-- `get(id)` -> timer: get a timer via its id
-- `create(type, ms, callback)` -> timer: creates a timer, adding it to the timer pool.
-`type` is the type of timer it will be. 0 is an interval, 1 is a timeout.
-`ms` is the time it will run for in seconds. callback is the function called
-when the timer is triggered.
-
-# Timer Object
-All those previously mentioned functions return a `timer` object, to which
-you can stop and start a timer again.
-
-An example of usage:
-local t = hilbish.timers.create(1, 5000, function()
-	print 'hello!'
-end)
-
-t:stop()
-print(t.running, t.duration, t.type)
-t:start()
-
-## Properties
-- `duration`: amount of time the timer runs for in milliseconds
-- `running`: whether the timer is running or not
-- `type`: the type of timer (0 is interval, 1 is timeout)
-
-## Functions
-- `stop()`: stops the timer. returns an error if it's already stopped
-- `start()`: starts the timer. returns an error if it's already started
+This has been moved to the `hilbish.timers` API doc (accessible by `doc api hilbish.timers`)
diff --git a/timerhandler.go b/timerhandler.go
index 3a2ecbb..0594c23 100644
--- a/timerhandler.go
+++ b/timerhandler.go
@@ -119,9 +119,30 @@ func (th *timersModule) luaGet(thr *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 // #property running If the timer is running
 // #property duration The duration in milliseconds that the timer will run
 // timeout and interval API
-// The timers interface si one to easily set timeouts and intervals
-// to run functions after a certain time or repeatedly without using
-// odd tricks.
+/*
+If you ever want to run a piece of code on a timed interval, or want to wait
+a few seconds, you don't have to rely on timing tricks, as Hilbish has a
+timer API to set intervals and timeouts.
+
+These are the simple functions `hilbish.interval` and `hilbish.timeout` (doc
+accessible with `doc hilbish`). But if you want slightly more control over
+them, there is the `hilbish.timers` interface. It allows you to get
+a timer via ID and control them.
+
+## Timer Object
+All functions documented with the `Timer` type refer to a Timer object.
+
+An example of usage:
+```
+local t = hilbish.timers.create(1, 5000, function()
+	print 'hello!'
+end)
+```
+
+t:stop()
+print(t.running, t.duration, t.type)
+t:start()
+*/
 func (th *timersModule) loader(rtm *rt.Runtime) *rt.Table {
 	timerMethods := rt.NewTable()
 	timerFuncs := map[string]util.LuaExport{