doc: Fix an incorrect signal name. (#2943)
Reported by @unai-ndz See #1373
This commit is contained in:
parent
3cc43f1be3
commit
a6e52a8c42
|
@ -81,7 +81,7 @@ local displayed_deprecations = {}
|
||||||
|
|
||||||
--- Display a deprecation notice, but only once per traceback.
|
--- Display a deprecation notice, but only once per traceback.
|
||||||
--
|
--
|
||||||
-- This function also emits the `debug::deprecate` signal on the `awesome`
|
-- This function also emits the `debug::deprecation` signal on the `awesome`
|
||||||
-- global object.
|
-- global object.
|
||||||
--
|
--
|
||||||
-- @param[opt] see The message to a new method / function to use.
|
-- @param[opt] see The message to a new method / function to use.
|
||||||
|
@ -90,6 +90,10 @@ local displayed_deprecations = {}
|
||||||
-- @tparam integer args.deprecated_in Print the message only when Awesome's
|
-- @tparam integer args.deprecated_in Print the message only when Awesome's
|
||||||
-- version is equal to or greater than deprecated_in.
|
-- version is equal to or greater than deprecated_in.
|
||||||
-- @staticfct gears.debug.deprecate
|
-- @staticfct gears.debug.deprecate
|
||||||
|
-- @emits debug::deprecation
|
||||||
|
-- @emitstparam @emitstparam string msg The full formatted message.
|
||||||
|
-- @emitstparam @emitstparam string see A message provided by the caller.
|
||||||
|
-- @emitstparam @emitstparam table args Some extra context.
|
||||||
function debug.deprecate(see, args)
|
function debug.deprecate(see, args)
|
||||||
args = args or {}
|
args = args or {}
|
||||||
if args.deprecated_in then
|
if args.deprecated_in then
|
||||||
|
|
Loading…
Reference in New Issue