doc: Better document awful.placement.next_to

2018-12-24 21:52:08 -05:00 · 2018-12-24 21:52:08 -05:00 · e2f164208c
parent 8bcdd0b794
commit e2f164208c
1 changed files with 8 additions and 0 deletions
--- 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