awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/common/widget.ldoc
View File

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

8
docs/config.ld
View File

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

2
lib/awful/widget/calendar_popup.lua
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`. -- 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: -- The calendar style can be tweaked by providing tables of style properties at creation: