mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
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:
parent
0367af2be9
commit
74276b3a11
1 changed files with 2 additions and 1 deletions
|
@ -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).
|
||||
|
|
Loading…
Reference in a new issue