Module:No globals/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
{{Meta module}}
{{Meta module}}


This module prevents the use of [[wikipedia:Global variable|global variables]] within [[gphelp:Extension:Scribunto|Scribunto]] modules, in order to avoid creating bugs that are difficult to track down. When using this module, an error will be thrown if any nil global is read or if any global is written to, with the exception of <var>arg</var>. The <var>arg</var> variable is excluded because it is necessary for Scribunto's [[mw:Extension:Scribunto/Lua reference manual#require|require]] function to work properly.
This module prevents the use of [[wikipedia:Global variable|global variables]] within [[mw:Extension:Scribunto|Scribunto]] modules, in order to avoid creating bugs that are difficult to track down. When using this module, an error will be thrown if any nil global is read or if any global is written to, with the exception of <var>arg</var>. The <var>arg</var> variable is excluded because it is necessary for Scribunto's [[mw:Extension:Scribunto/Lua reference manual#require|require]] function to work properly.


==Usage==
==Usage==
Place {{code|lang=lua|require('Module:No globals')}} at the top of the module using it.
Place {{code|lang=lua|require('Module:No globals')}} at the top of the module using it.
{{Adapted from Wikipedia|Module:No globals}}


{{Documentation categories|
{{Documentation categories|

Latest revision as of 22:02, 1 January 2022

This subpage provides documentation for Module:No globals.

This is a meta module.

This module is meant to be used only by other modules. It should not be invoked in wikitext.

This module prevents the use of global variables within Scribunto modules, in order to avoid creating bugs that are difficult to track down. When using this module, an error will be thrown if any nil global is read or if any global is written to, with the exception of arg. The arg variable is excluded because it is necessary for Scribunto's require function to work properly.

Usage

Place require('Module:No globals') at the top of the module using it.

This module was adapted from Module:No globals on Wikipedia.
Adaptation is noted for reference and attribution only. This module may differ from the original in function or in usage.