From 8966c73599dae9210754299119214cede3226317 Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Sun, 6 Mar 2016 14:46:13 +0100 Subject: [PATCH] Minor doc fixes --- lib/awful/widget/common.lua | 2 +- lib/beautiful/init.lua | 5 ++--- lib/wibox/layout/ratio.lua | 8 ++++---- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/lib/awful/widget/common.lua b/lib/awful/widget/common.lua index bfba6eae..cfe18b7d 100644 --- a/lib/awful/widget/common.lua +++ b/lib/awful/widget/common.lua @@ -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 } diff --git a/lib/beautiful/init.lua b/lib/beautiful/init.lua index d7f95f2f..5fb14048 100644 --- a/lib/beautiful/init.lua +++ b/lib/beautiful/init.lua @@ -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 .. "/") diff --git a/lib/wibox/layout/ratio.lua b/lib/wibox/layout/ratio.lua index 9f623140..25c00347 100644 --- a/lib/wibox/layout/ratio.lua +++ b/lib/wibox/layout/ratio.lua @@ -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)