doc: improve/fix doc for awful.rules (#2005)

2017-08-20 19:37:03 +02:00 · 2017-08-20 19:37:03 +02:00 · 784472f212
parent a1911b5a23
commit 784472f212
2 changed files with 5 additions and 2 deletions
--- a/lib/awful/rules.lua
+++ b/lib/awful/rules.lua
@ -1,5 +1,8 @@
 ---------------------------------------------------------------------------
--- Apply rules to clients at startup.
+--- Rules for clients.
+--
+-- This module applies @{rules} to clients during startup (via @{client.manage},
+-- but its functions can be used for client matching in general.
 --
 -- All existing `client` properties can be used in rules. It is also possible
 -- to add random properties that will be later accessible as `c.property_name`
--- a/objects/client.c
+++ b/objects/client.c
@ -125,7 +125,7 @@
 * @signal .swapped
 */

-/**
+/** When a new client appears and gets managed by Awesome.
 * @signal .manage
 */