Difference between revisions of "Help:Function syntax"
→Summary
imported>DragoonWraith (→Syntax: adding an example alias) |
imported>DragoonWraith |
||
| Line 43: | Line 43: | ||
== Summary == | == Summary == | ||
This section describes what the function does, in some cases in great detail. At the very least, a function should describe exactly what each of the function's arguments do, what you can expect the return value to be in various situations, and any side-effects that running the function may cause (such as changing in-game statistics, moving objects, etc.). | This section describes what the function does, in some cases in great detail. At the very least, a function should describe exactly what each of the function's arguments do (including the default values of any optional arguments), what you can expect the return value to be in various situations, and any side-effects that running the function may cause (such as changing in-game statistics, moving objects, etc.). | ||
== Example == | == Example == | ||