doc: Fix an incorrect signal name. (#2943)

Reported by @unai-ndz

See #1373
This commit is contained in:
Emmanuel Lepage Vallée 2019-12-11 10:01:54 -08:00 committed by GitHub
parent 3cc43f1be3
commit a6e52a8c42
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions

View File

@ -81,7 +81,7 @@ local displayed_deprecations = {}
--- 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.
--
-- @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
-- version is equal to or greater than deprecated_in.
-- @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)
args = args or {}
if args.deprecated_in then