From 1b49a20e0dd23d05345d08ecb8e2b3df83cccc0b Mon Sep 17 00:00:00 2001 From: Lucas Schwiderski Date: Sat, 22 May 2021 01:24:07 +0200 Subject: [PATCH] doc(awful.client): Document special signal semantics While the documentation already specified the signal via `@emits`, it did not make it clear that this signal is emitted on a `tag` object, rather than the `client`. Signed-off-by: Lucas Schwiderski --- lib/awful/client.lua | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/awful/client.lua b/lib/awful/client.lua index 3e5fc8205..041ea2cb1 100644 --- a/lib/awful/client.lua +++ b/lib/awful/client.lua @@ -1159,10 +1159,13 @@ end --- Change window factor of a client. -- +-- This will emit `property::windowfact` on the specific tag object +-- `c.screen.selected_tag`. +-- -- @legacylayout awful.client.incwfact --- @tparam number add Amount to increase/decrease the client's window factor. +-- @tparam number add Amount to increase/decrease the client's window factor by. -- Should be between `-current_window_factor` and something close to --- infinite. The normalisation then ensures that the sum of all factors is 1. +-- infinite. Normalisation then ensures that the sum of all factors is 1. -- @tparam client c the client. -- @emits property::windowfact function client.incwfact(add, c)