doc: Standardize the function name.

There was some issues like `gears.shape.circle` being called
`module.circle`.

There is also a disparity between how the constructor and "normal"
functions are called.

This commit attempts to force everything to have the full module name.
This commit is contained in:
Emmanuel Lepage Vallee 2019-06-06 01:02:31 -04:00
parent d92fda78c4
commit 89a02ac6cd
1 changed files with 14 additions and 0 deletions

View File

@ -169,6 +169,20 @@ custom_display_name_handler = function(item, default_handler)
-- just redundant. -- just redundant.
ret = ret:gsub("([^:]*)(:[^:])","%2") ret = ret:gsub("([^:]*)(:[^:])","%2")
-- Undocumented API to get rid of `module.rounded_rect` rather than
-- `gears.shape.rounded_rect`
if ret:sub(1, 7) == "module." and module then
return ret:gsub("^module", item.module.name)
end
-- Undocumented API to make the libraries and classmod "function" section
-- more consistent. Right now some have their full awful.foo.bar while other
-- have "just" `bar`. Given we use constructors from metatables, we have no
-- choice but to use the full function name. It also makes copy/paste easier.
if item.type == "function" and (not ret:find(".", 1, true)) and (not ret:find(":", 1, true)) then
return item.module.name .. "." .. ret
end
return ret return ret
end end