Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor doc fixes

This commit is contained in:
Daniel Hahler 2016-03-06 14:46:13 +01:00
parent 93e50b2e23
commit 8966c73599
3 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/awful/widget/common.lua
View File

@ -24,7 +24,7 @@ function common.create_buttons(buttons, object)
local btns = {} local btns = {}
for _, b in ipairs(buttons) do for _, b in ipairs(buttons) do
-- Create a proxy button object: it will receive the real -- Create a proxy button object: it will receive the real
-- press and release events, and will propagate them the the -- press and release events, and will propagate them to the
-- button object the user provided, but with the object as -- button object the user provided, but with the object as
-- argument. -- argument.
local btn = capi.button { modifiers = b.modifiers, button = b.button } local btn = capi.button { modifiers = b.modifiers, button = b.button }

5
lib/beautiful/init.lua
View File

@ -112,9 +112,8 @@ function beautiful.init(config)
if config then if config then
local homedir = os.getenv("HOME") local homedir = os.getenv("HOME")
-- If config is the path to the theme file, -- If `config` is the path to a theme file, run this file,
-- run this file, -- otherwise if it is a theme table, save it.
-- else if it is the theme table, save it
if type(config) == 'string' then if type(config) == 'string' then
-- Expand the '~' $HOME shortcut -- Expand the '~' $HOME shortcut
config = config:gsub("^~/", homedir .. "/") config = config:gsub("^~/", homedir .. "/")

8
lib/wibox/layout/ratio.lua
View File

@ -215,7 +215,7 @@ function ratio:set_ratio(index, percent)
self:emit_signal("widget::layout_changed") self:emit_signal("widget::layout_changed")
end end
--- The the ratio at `index` --- Get the ratio at `index`.
-- @tparam number index The widget index to query -- @tparam number index The widget index to query
-- @treturn number The index (between 0 and 1) -- @treturn number The index (between 0 and 1)
function ratio:get_ratio(index) function ratio:get_ratio(index)
@ -223,9 +223,9 @@ function ratio:get_ratio(index)
return self._ratios[index] return self._ratios[index]
end end
--- Set the ratio of "widget" --- Set the ratio of `widget` to `percent`.
-- @param widget The widget to ajust -- @tparam widget widget The widget to ajust.
-- @tparam number percent An floating point value between 0 and 1 -- @tparam number percent A floating point value between 0 and 1.
function ratio:set_widget_ratio(widget, percent) function ratio:set_widget_ratio(widget, percent)
local index = self:index(widget) local index = self:index(widget)