From 74276b3a1171bbb819552e9394e4e5b9baff66cf Mon Sep 17 00:00:00 2001
From: Uli Schlachter <psychon@znc.in>
Date: Tue, 11 Aug 2015 13:29:49 +0200
Subject: [PATCH] gears.timer: Add a note about GC'ing timers

Ref: https://github.com/awesomeWM/awesome/issues/216

Signed-off-by: Uli Schlachter <psychon@znc.in>
---
 lib/gears/timer.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/gears/timer.lua b/lib/gears/timer.lua
index f95bfe2a..3a14dfbb 100644
--- a/lib/gears/timer.lua
+++ b/lib/gears/timer.lua
@@ -20,7 +20,8 @@ local object = require("gears.object")
 
 --- Timer objects. This type of object is useful when triggering events repeatedly.
 -- The timer will emit the "timeout" signal every N seconds, N being the timeout
--- value.
+-- value. Note that a started timer will not be garbage collected. Call `:stop`
+-- to enable garbage collection.
 -- @tfield number timeout Interval in seconds to emit the timeout signal.
 --                        Can be any value, including floating point ones
 --                        (e.g. 1.5 seconds).