From e2f164208c1c1665fa992f50f5a6788220bce9a2 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Mon, 24 Dec 2018 21:52:08 -0500 Subject: [PATCH] doc: Better document awful.placement.next_to --- lib/awful/placement.lua | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/awful/placement.lua b/lib/awful/placement.lua index 578280fb..cc77d7ce 100644 --- a/lib/awful/placement.lua +++ b/lib/awful/placement.lua @@ -1383,6 +1383,14 @@ end -- --@DOC_awful_placement_next_to_EXAMPLE@ -- +-- The `args.mode` parameters allows to control from which `next_to` takes its +-- source object from. The valid values are: +-- +-- * geometry: Next to this geometry, `args.geometry` has to be set. +-- * cursor: Next to the mouse. +-- * cursor_inside +-- * geometry_inside +-- -- @tparam drawable d A wibox or client -- @tparam table args -- @tparam string args.mode The mode