mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
Minor doc fixes
This commit is contained in:
parent
93e50b2e23
commit
8966c73599
3 changed files with 7 additions and 8 deletions
|
@ -24,7 +24,7 @@ function common.create_buttons(buttons, object)
|
|||
local btns = {}
|
||||
for _, b in ipairs(buttons) do
|
||||
-- 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
|
||||
-- argument.
|
||||
local btn = capi.button { modifiers = b.modifiers, button = b.button }
|
||||
|
|
|
@ -112,9 +112,8 @@ function beautiful.init(config)
|
|||
if config then
|
||||
local homedir = os.getenv("HOME")
|
||||
|
||||
-- If config is the path to the theme file,
|
||||
-- run this file,
|
||||
-- else if it is the theme table, save it
|
||||
-- If `config` is the path to a theme file, run this file,
|
||||
-- otherwise if it is a theme table, save it.
|
||||
if type(config) == 'string' then
|
||||
-- Expand the '~' $HOME shortcut
|
||||
config = config:gsub("^~/", homedir .. "/")
|
||||
|
|
|
@ -215,7 +215,7 @@ function ratio:set_ratio(index, percent)
|
|||
self:emit_signal("widget::layout_changed")
|
||||
end
|
||||
|
||||
--- The the ratio at `index`
|
||||
--- Get the ratio at `index`.
|
||||
-- @tparam number index The widget index to query
|
||||
-- @treturn number The index (between 0 and 1)
|
||||
function ratio:get_ratio(index)
|
||||
|
@ -223,9 +223,9 @@ function ratio:get_ratio(index)
|
|||
return self._ratios[index]
|
||||
end
|
||||
|
||||
--- Set the ratio of "widget"
|
||||
-- @param widget The widget to ajust
|
||||
-- @tparam number percent An floating point value between 0 and 1
|
||||
--- Set the ratio of `widget` to `percent`.
|
||||
-- @tparam widget widget The widget to ajust.
|
||||
-- @tparam number percent A floating point value between 0 and 1.
|
||||
function ratio:set_widget_ratio(widget, percent)
|
||||
local index = self:index(widget)
|
||||
|
||||
|
|
Loading…
Reference in a new issue