Module:Deprecated
Marks items as deprecated, and provides a warning when they are called.
Marks items as deprecated, and provides a warning when they are called.
Limitations
This module will not provide a warning if a deprecated item is called from within the same module that this module is used.
Documentation
Package function
deprecated(p, deprecatedTable)(function)- Marks items as deprecated, and provides a warning when they are called.
- Parameters:
ppackage frame (table)deprecatedTable
- Returns: package
Other items
--- Marks items as deprecated, and provides a warning when they are called.
--
-- ## Limitations ##
-- This module will not provide a warning if a deprecated item is called from
-- within the same module that this module is used.
--
-- @release alpha
-- @author [[User:Awesome_Aasim|Awesome Aasim]]
-- @function deprecated
-- @param {table} p package frame
-- @param deprecatedTable
-- @return package
return function(p, deprecatedTable, replacement)
local pckg = {}
--- Warn
-- @param {string} text warning text
function warn(text)
local tb = debug.traceback()
mw.log(text .. '\n' .. tb)
mw.addWarning(text .. tb:gsub("\n", "<br/>"):gsub("\t", " "))
end
if deprecatedTable == nil or deprecatedTable == true then
deprecatedTable = {}
for k,_ in pairs(p) do
deprecatedTable[k] = {
deprecated = true,
replacement = replacement or ""
}
end
end
setmetatable(pckg, {
__index = function(t, index)
if deprecatedTable[index] and deprecatedTable[index]["deprecated"] then
warn(
mw.ustring.format(
"Deprecated member <code>%s</code> called. ", index
) .. (
deprecatedTable[index]["replacement"]
and mw.ustring.format("Please %s instead.", deprecatedTable[index]["replacement"])
or ''
)
)
end
return p[index]
end
})
return pckg
end
Content Disclaimer
Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.
- The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
- There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
- It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
- Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
- Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.