Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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>
This commit is contained in:
Uli Schlachter 2015-08-11 13:29:49 +02:00
parent 0367af2be9
commit 74276b3a11
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/gears/timer.lua
View File

@ -20,7 +20,8 @@ local object = require("gears.object")
--- Timer objects. This type of object is useful when triggering events repeatedly. --- 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 -- 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. -- @tfield number timeout Interval in seconds to emit the timeout signal.
-- Can be any value, including floating point ones -- Can be any value, including floating point ones
-- (e.g. 1.5 seconds). -- (e.g. 1.5 seconds).