From f7f8420d241d662a3af41f4aee451115d7fe271b Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Wed, 23 Sep 2015 10:37:02 +0200 Subject: [PATCH] naughty.notify: improve doc for args.run Closes https://github.com/awesomeWM/awesome/pull/469. --- lib/naughty/core.lua | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/naughty/core.lua b/lib/naughty/core.lua index 2b99e5e8..5885f2ad 100644 --- a/lib/naughty/core.lua +++ b/lib/naughty/core.lua @@ -407,7 +407,11 @@ end -- @string[opt=`beautiful.bg_focus` or `'#535d6c'`] args.bg Background color. -- @int[opt=1] args.border_width Border width. -- @string[opt=`beautiful.border_focus` or `'#535d6c'`] args.border_color Border color. --- @tparam[opt] func args.run Function to run on left click. +-- @tparam[opt] func args.run Function to run on left click. The notification +-- object will be passed to it as an argument. +-- You need to call e.g. +-- `notification.die(naughty.notificationClosedReason.dismissedByUser)` from +-- there to dismiss the notification yourself. -- @tparam[opt] func args.destroy Function to run when notification is destroyed. -- @tparam[opt] table args.preset Table with any of the above parameters. -- Note: Any parameters specified directly in args will override ones defined