From 3b40954223a0efcfd0988f36b0ac86a564e4041e Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Sat, 25 Feb 2017 16:56:51 +0100 Subject: [PATCH] wibox.container.scroll: Add a description Signed-off-by: Uli Schlachter --- lib/wibox/container/scroll.lua | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/wibox/container/scroll.lua b/lib/wibox/container/scroll.lua index 08cc64a5b..112d52650 100644 --- a/lib/wibox/container/scroll.lua +++ b/lib/wibox/container/scroll.lua @@ -1,4 +1,7 @@ --------------------------------------------------------------------------- +-- This container scrolls its inner widget inside of the available space. An +-- example usage would be a text widget that displays information about the +-- currently playing song without using too much space for long song titles. -- @usage -- wibox.widget { -- layout = wibox.container.scroll.horizontal,