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

doc: Fix awful.hotkeys_popup.show_help formatting.

This commit is contained in:
Emmanuel Lepage Vallee 2019-01-13 23:56:11 -05:00
parent fec7aaa569
commit 4b76ca9d38
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/awful/hotkeys_popup/init.lua
View File

@ -10,15 +10,22 @@ local hotkeys_popup = {
widget = require("awful.hotkeys_popup.widget"),
}
--- This is the same as awful.hotkeys_popup.widget.show_help
--- This is the same as awful.hotkeys_popup.widget.show_help.
--
-- example usage:
--
-- local hotkeys_popup = require("awful.hotkeys_popup")
-- myawesomemenu = {{ "hotkeys", function() hotkeys_popup.show_help() end },
-- -- <more entries>
-- }
--
-- see `awful.hotkeys_popup.widget.show_help` for more information
-- @tparam[opt] client c The hostkeys for the client "c".
-- @tparam[opt] screen s The screen.
-- @tparam[opt=true] boolean show_args.show_awesome_keys Show AwesomeWM hotkeys.
-- When set to `false` only app-specific hotkeys will be shown.
-- @function awful.hotkeys_popup.show_help
-- @see awful.hotkeys_popup.widget.show_help
hotkeys_popup.show_help = hotkeys_popup.widget.show_help
return hotkeys_popup