Module:Util/pages/dpl/Documentation/Spec

Documentation for this module may be created at Module:Util/pages/dpl/Documentation/Spec/Documentation

local p = {}

function p.Documentation()
	return {
		desc = "<p>This function is wrapper for the [[gphelp:Extension:DPL3/Manual|DPL]] parser function.</p>"
			.. "<p>When constructing queries, keep in mind DPL's [https://www.mediawiki.org/wiki/Extension:DynamicPageList3#Configuration configured limits].</p>"
			.. "<ul>"
			..   "<li>A single query can return no more than 500 results. (<code>maxResultCount</code>)</li>"
			..   "<li>A single query using <code>category</code> selection may contain no more than 4 categories. (<code>maxCategoryCount</code>)</li>"
			.. "</ul>",
		params = {"args"},
		returns = "Array of results.",
		cases = {
			{
				args = { {titlematch = "Link|Zelda", namespace = "Category"} },
				expect = {"Category:Link", "Category:Zelda"}
			},
			{
				desc = "Repeating arguments",
				args = {
					{
						category = "Lynels",
						notcategory = {
							"Sub-Bosses",
							"Enemies in Hyrule Warriors: Age of Calamity",
						},
					},
				},
				expect = {"Blue Lynel", "Red Lynel"},
			},
		},
	}
end

return p