wibox.container.scroll: Add a description

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2017-02-25 16:56:51 +01:00
parent 6fb40a196f
commit 3b40954223
1 changed files with 3 additions and 0 deletions

View File

@ -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 -- @usage
-- wibox.widget { -- wibox.widget {
-- layout = wibox.container.scroll.horizontal, -- layout = wibox.container.scroll.horizontal,