Module:No globals/doc: Difference between revisions
Jump to navigation
Jump to search
(Need to put {{Documentation subpage}} here after all: Explanation.) |
>Vinifera7 No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{ | 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. | ||
==Usage== | |||
Place {{code|lang=lua|require('Module:No globals')}} at the top of the module using it. | |||
{{Documentation categories| | {{Documentation categories| | ||
Revision as of 10:49, 13 July 2021
This subpage provides documentation for Module:No globals.
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.