naughty: Un-document naughty.notification.replaces_id.

It doesn't and cannot exists within `naughty.notification()` since it is
a constructor and that's way too late.

Ref #2816
This commit is contained in:
Emmanuel Lepage Vallee 2019-07-11 00:06:24 -04:00
parent f3ee880bd8
commit 11ef560c5c
1 changed files with 2 additions and 7 deletions

View File

@ -235,10 +235,6 @@ local notification = {}
-- @property preset -- @property preset
-- @param table -- @param table
--- Replace the notification with the given ID.
-- @property replaces_id
-- @param number
--- Function that will be called with all arguments. --- Function that will be called with all arguments.
-- The notification will only be displayed if the function returns true. -- The notification will only be displayed if the function returns true.
-- Note: this function is only relevant to notifications sent via dbus. -- Note: this function is only relevant to notifications sent via dbus.
@ -394,8 +390,8 @@ local properties = {
"width" , "font" , "icon" , "icon_size" , "width" , "font" , "icon" , "icon_size" ,
"fg" , "bg" , "height" , "border_color" , "fg" , "bg" , "height" , "border_color" ,
"shape" , "opacity" , "margin" , "ignore_suspend", "shape" , "opacity" , "margin" , "ignore_suspend",
"destroy" , "preset" , "callback", "replaces_id" , "destroy" , "preset" , "callback", "actions" ,
"actions" , "run" , "id" , "ignore" , "run" , "id" , "ignore",
} }
for _, prop in ipairs(properties) do for _, prop in ipairs(properties) do
@ -496,7 +492,6 @@ end
-- @tparam[opt] table args.preset Table with any of the above parameters. -- @tparam[opt] table args.preset Table with any of the above parameters.
-- Note: Any parameters specified directly in args will override ones defined -- Note: Any parameters specified directly in args will override ones defined
-- in the preset. -- in the preset.
-- @tparam[opt] int args.replaces_id Replace the notification with the given ID.
-- @tparam[opt] func args.callback Function that will be called with all arguments. -- @tparam[opt] func args.callback Function that will be called with all arguments.
-- The notification will only be displayed if the function returns true. -- The notification will only be displayed if the function returns true.
-- Note: this function is only relevant to notifications sent via dbus. -- Note: this function is only relevant to notifications sent via dbus.