awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve docs for emit_signal_recursive (#1998) 

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2017-08-16 13:37:14 +02:00 committed by Daniel Hahler
parent ef04fa688e
commit 12bb7f5a9e
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/wibox/widget/base.lua
View File

@ -162,14 +162,16 @@ end
-- forward the signal. This is useful to track signals when there is a dynamic -- forward the signal. This is useful to track signals when there is a dynamic
-- set of containers and layouts wrapping the widget. -- set of containers and layouts wrapping the widget.
-- --
-- Note that this function has two flaws: -- Note that this function has some flaws:
-- --
-- 1. The signal is only forwarded once the widget tree has been built. This -- 1. The signal is only forwarded once the widget tree has been built. This
-- happens after all currently scheduled functions have been executed. -- happens after all currently scheduled functions have been executed.
-- Therefore, it will not start to work right away. -- Therefore, it will not start to work right away.
-- 2. In case the widget is present multiple times in a single widget tree, -- 2. In case the widget is present multiple times in a single widget tree,
-- this function will also forward the signal multiple time (one per upward -- this function will also forward the signal multiple times (once per upward
-- tree path). -- tree path).
-- 3. If the widget is removed from the widget tree, the signal is still
-- forwarded for some time, similar to the first case.
-- --
-- @tparam string signal_name -- @tparam string signal_name
-- @param ... Other arguments -- @param ... Other arguments