doc: Fix issues found by @aire-one.

This commit is contained in:
Emmanuel Lepage Vallee 2022-08-28 00:17:17 -07:00
parent fc95f43bde
commit 3c0d5b606f
3 changed files with 7 additions and 6 deletions

View File

@ -72,8 +72,9 @@
-- The table contains a list of `awful.button` objects.
--
-- @property buttons
-- @tparam table buttons
-- @tparam[opt={}] table buttons
-- @see awful.button
-- @tablerowtype A list of `awful.button`.
-- @baseclass wibox.widget
--- Add a new `awful.button` to this widget.

View File

@ -334,7 +334,7 @@ create_type {
return
end
local param, sublist = item:subparam(item.params[1])
local _, sublist = item:subparam(item.params[1])
local type = item:type_of_param(item.params[1])
-- Force people to use @tparam because it is easier to lint and allows
@ -347,10 +347,10 @@ create_type {
)
end
if type == "bool" then
if type_name_linting[type] then
print(
"WARNING: Property ".. item.name .." from "..item.module.name..
" type is `bool`, please use `boolean`."
" type is `"..type.."`, please use `"..type_name_linting[type].."`."
)
end
@ -371,7 +371,7 @@ create_type {
if def then
-- Detect the blatant missing quote marks for string. This is important
-- to differentiate variables from string literals.
if type == "string" and def:sub(1,1) ~= '"' and not def:find(".") then
if type == "string" and def:sub(1,1) ~= '"' and def:sub(-1) ~= '"' and not def:find(".") then
print(
"WARNING: Property ".. item.name .." from "..item.module.name..
" is a string, but the default value is not quoted."

View File

@ -1,5 +1,5 @@
---------------------------------------------------------------------------
-- A popup wibox containing a `wibox.widget,calendar` widget.
-- A popup wibox containing a `wibox.widget.calendar` widget.
--
-- Display a month or year calendar popup using `calendar_popup.month` or `calendar_popup.year`.
-- The calendar style can be tweaked by providing tables of style properties at creation: