Module:Example - Revision history

Awesome Aasim: add ldoc comments to example

2025-03-09T22:15:06Z

add ldoc comments to example

← Previous revision		Revision as of 22:15, 9 March 2025
Line 1:		Line 1:
			--- Example module.
			-- @module example
			-- @alias p


	local p = {} --All Lua modules on Wikipedia must begin by defining a variable		local p = {} --All Lua modules on Wikipedia must begin by defining a variable
	--that will hold their externally accessible functions.		--that will hold their externally accessible functions.
	--Such variables can have whatever name you want and may		--Such variables can have whatever name you want and may
	--also contain various data as well as functions.		--also contain various data as well as functions.

			--- Hello world function
			-- @param {table} frame current frame
			-- @return Hello world
	p.hello = function( frame ) --Add a function to "p".		p.hello = function( frame ) --Add a function to "p".
	--Such functions are callable in Wikipedia		--Such functions are callable in Wikipedia
Line 17:		Line 26:

	end -- end of the function "hello"		end -- end of the function "hello"

			--- Hello world function
			-- @param {table} frame current frame
			-- @param {string} frame.args[1] name
			-- @return Hello world
	function p.hello_to(frame) -- Add another function		function p.hello_to(frame) -- Add another function
	local name = frame.args[1] -- To access arguments passed to a module, use `frame.args`		local name = frame.args[1] -- To access arguments passed to a module, use `frame.args`
Line 24:		Line 38:
	-- greeting depending on the name given, such as "Hello, Fred!"		-- greeting depending on the name given, such as "Hello, Fred!"
	end		end

			--- Counts fruit
			-- @param {table} frame current frame
			-- @param {string} frame.args.bananas number of bananas
			-- @param {string} frame.args.apples number of apples
			-- @return Number of apples and bananas
	function p.count_fruit(frame)		function p.count_fruit(frame)

Line 41:		Line 61:
	end		end

			--- Lucky function
			-- @param {string} a
			-- @param {string} b
			-- @return Whether a is lucky.
	local function lucky(a, b) -- One can define custom functions for use. Here we define a function 'lucky' that has two inputs a and b. The names are of your choice.		local function lucky(a, b) -- One can define custom functions for use. Here we define a function 'lucky' that has two inputs a and b. The names are of your choice.
	if b == 'yeah' then -- Condition: if b is the string 'yeah'. Strings require quotes. Remember to include 'then'.		if b == 'yeah' then -- Condition: if b is the string 'yeah'. Strings require quotes. Remember to include 'then'.
Line 49:		Line 73:
	end -- As should 'function'.		end -- As should 'function'.

			--- Name2
			-- @param {table} frame current frame
			-- @return Some output
	function p.Name2(frame)		function p.Name2(frame)
	-- The next five lines are mostly for convenience only and can be used as is for your module. The output conditions start on line 50.		-- The next five lines are mostly for convenience only and can be used as is for your module. The output conditions start on line 50.

Dgrilawidbanana: I see no reason for this semicolon, save for confusing readers

2024-11-11T22:36:51Z

I see no reason for this semicolon, save for confusing readers

← Previous revision		Revision as of 22:36, 11 November 2024
Line 1:		Line 1:
	local p = {}; --All Lua modules on Wikipedia must begin by defining a variable		local p = {} --All Lua modules on Wikipedia must begin by defining a variable
	--that will hold their externally accessible functions.		--that will hold their externally accessible functions.
	--Such variables can have whatever name you want and may		--Such variables can have whatever name you want and may

QuickQuokka: Finally working

2023-08-29T03:23:27Z

Finally working

← Previous revision		Revision as of 03:23, 29 August 2023
Line 25:		Line 25:
	end		end
	function p.count_fruit(frame)		function p.count_fruit(frame)

	local num_bananas = frame.args.bananas -- Named arguments ({{#invoke:Example\|count_fruit\|foo=bar}}) are likewise
	local ~~num_apples~~ = frame.args.~~apples~~ -- ~~accessed~~ ~~by indexing `frame.args` by name~~ (~~`frame.args["bananas"]`, or~~)		local num_bananas = tonumber(frame.args.bananas) or 0 -- Named arguments ({{#invoke:Example\|count_fruit\|foo=bar}})
			local num_apples = tonumber(frame.args.apples) or 0 -- are likewise accessed by indexing `frame.args` by name (`frame.args["bananas"]`,
	-- equivalently `frame.args.bananas`.		-- or equivalently `frame.args.bananas`.
⚫	return 'I have ' .. num_bananas .. ' ~~bananas~~ and ' .. num_apples .. ' ~~apples~~'

			local conj_bananas = num_bananas == 1 and 'banana' or 'bananas'
			local conj_apples = num_apples == 1 and 'apple' or 'apples'
			-- Ternary operators assign values based on a condition in a compact way.
			-- Here, `conj_bananas` gets `'banana'` if `num_bananas` is 1, else `'bananas'`.
			-- Similarly, `conj_apples` gets `'apple'` if `num_apples` is 1, else `'apples'`.

		⚫	return 'I have ' .. num_bananas .. ' ' .. conj_bananas .. ' and ' .. num_apples .. ' ' .. conj_apples
	-- Like above, concatenate a bunch of strings together to produce		-- Like above, concatenate a bunch of strings together to produce
	-- a sentence based on the arguments given.		-- a sentence based on the arguments given.

QuickQuokka: Undid revision 1172755373 by QuickQuokka (talk) Whoopsie, this results in an error!

2023-08-29T02:56:58Z

Undid revision 1172755373 by QuickQuokka (talk) Whoopsie, this results in an error!

@@ Line 25: / Line 25: @@
 end
 function p.count_fruit(frame)
-	local num_bananas = tonumber(frame.args.bananas) or 0	-- Named arguments ({{#invoke:Example|count_fruit|foo=bar}})
+	local num_apples = frame.args.apples   -- accessed by indexing `frame.args` by name (`frame.args["bananas"]`, or)
 										   -- Like above, concatenate a bunch of strings together to produce
 										   -- a sentence based on the arguments given.

QuickQuokka: Per the hopefully soon to be policy WP:LLM, the comment on the ternary operators was written by ChatGPT

2023-08-29T02:55:07Z

Per the hopefully soon to be policy WP:LLM, the comment on the ternary operators was written by ChatGPT

← Previous revision		Revision as of 02:55, 29 August 2023
Line 25:		Line 25:
	end		end
	function p.count_fruit(frame)		function p.count_fruit(frame)

	local num_bananas = frame.args.bananas -- Named arguments ({{#invoke:Example\|count_fruit\|foo=bar}}) are likewise
	local ~~num_apples~~ = frame.args.~~apples~~ -- ~~accessed~~ ~~by indexing `frame.args` by name~~ (~~`frame.args["bananas"]`, or~~)		local num_bananas = tonumber(frame.args.bananas) or 0 -- Named arguments ({{#invoke:Example\|count_fruit\|foo=bar}})
			local num_bananas = tonumber(frame.args.bananas) or 0 -- are likewise accessed by indexing `frame.args` by name (`frame.args["bananas"]`,
	-- equivalently `frame.args.bananas`.		-- or equivalently `frame.args.bananas`.
⚫	return 'I have ' .. num_bananas .. ' ~~bananas~~ and ' .. num_apples .. ' ~~apples~~'

			local conj_bananas = num_bananas == 1 and 'banana' or 'bananas'
			local conj_apples = num_apples == 1 and 'apple' or 'apples'
			-- Ternary operators assign values based on a condition in a compact way.
			-- Here, `conj_bananas` gets `'banana'` if `num_bananas` is 1, else `'bananas'`.
			-- Similarly, `conj_apples` gets `'apple'` if `num_apples` is 1, else `'apples'`.

		⚫	return 'I have ' .. num_bananas .. ' ' .. conj_bananas .. ' and ' .. num_apples .. ' ' .. conj_apples
	-- Like above, concatenate a bunch of strings together to produce		-- Like above, concatenate a bunch of strings together to produce
	-- a sentence based on the arguments given.		-- a sentence based on the arguments given.

Pinky sl: Reverted 1 edit by Pinky sl (talk): Sorry!

2023-05-31T16:37:20Z

Reverted 1 edit by Pinky sl (talk): Sorry!

← Previous revision		Revision as of 16:37, 31 May 2023
Line 10:		Line 10:
	-- 'Hello' is a name of your choice. The same name needs to be referred to when the module is used.		-- 'Hello' is a name of your choice. The same name needs to be referred to when the module is used.

	local str = "~~Živijo~~ ~~svet~~!" --Declare a local variable and set it equal to		local str = "Hello World!" --Declare a local variable and set it equal to
	--"~~Živijo~~ ~~svet~~!".		--"Hello World!".

	return str --This tells us to quit this function and send the information in		return str --This tells us to quit this function and send the information in

Pinky sl: Živijo svet

2023-05-31T16:36:45Z

Živijo svet

← Previous revision		Revision as of 16:36, 31 May 2023
Line 10:		Line 10:
	-- 'Hello' is a name of your choice. The same name needs to be referred to when the module is used.		-- 'Hello' is a name of your choice. The same name needs to be referred to when the module is used.

	local str = "~~Hello~~ ~~World~~!" --Declare a local variable and set it equal to		local str = "Živijo svet!" --Declare a local variable and set it equal to
	--"~~Hello~~ ~~World~~!".		--"Živijo svet!".

	return str --This tells us to quit this function and send the information in		return str --This tells us to quit this function and send the information in

2406:3003:2077:1E60:C998:20C6:8CCF:5730: upd line number

2022-06-30T14:05:54Z

upd line number

← Previous revision		Revision as of 14:05, 30 June 2022
Line 42:		Line 42:

	function p.Name2(frame)		function p.Name2(frame)
	-- The next five lines are mostly for convenience only and can be used as is for your module. The output conditions start on line 20.		-- The next five lines are mostly for convenience only and can be used as is for your module. The output conditions start on line 50.
	local pf = frame:getParent().args -- This line allows template parameters to be used in this code easily. The equal sign is used to define variables. 'pf' can be replaced with a word of your choice.		local pf = frame:getParent().args -- This line allows template parameters to be used in this code easily. The equal sign is used to define variables. 'pf' can be replaced with a word of your choice.
	local f = frame.args -- This line allows parameters from {{#invoke:}} to be used easily. 'f' can be replaced with a word of your choice.		local f = frame.args -- This line allows parameters from {{#invoke:}} to be used easily. 'f' can be replaced with a word of your choice.

QuinticFormula: Capitalised "lua" to "Lua" in the comments

2022-04-02T23:36:24Z

Capitalised "lua" to "Lua" in the comments

← Previous revision		Revision as of 23:36, 2 April 2022
Line 1:		Line 1:
	local p = {}; --All ~~lua~~ modules on Wikipedia must begin by defining a variable		local p = {}; --All Lua modules on Wikipedia must begin by defining a variable
	--that will hold their externally accessible functions.		--that will hold their externally accessible functions.
	--Such variables can have whatever name you want and may		--Such variables can have whatever name you want and may

Patrick at 11:42, 12 June 2021

2021-06-12T11:42:49Z

← Previous revision		Revision as of 11:42, 12 June 2021
Line 51:		Line 51:
	return 'Lonely' -- Outputs the string 'Lonely' if the first condition is met.		return 'Lonely' -- Outputs the string 'Lonely' if the first condition is met.
	elseif M > m then -- If the first condition is not met, this line tests a second condition: if M is greater than m.		elseif M > m then -- If the first condition is not met, this line tests a second condition: if M is greater than m.
	return lucky(M - m, l) -- If the condition is met, the difference is calculated and passed to ~~the~~ the self defined function along with l. The output depends on whether l is set to 'yeah'.		return lucky(M - m, l) -- If the condition is met, the difference is calculated and passed to the self defined function along with l. The output depends on whether l is set to 'yeah'.
	else		else
	return 'Be positive!'		return 'Be positive!'