style.lua(9): Clarify local variable guideline

The intent of this guideline is to avoid creating global variables in module
scope. Its main purpose is to serve as a reminder that variables at module
scope also need to be declared.

We want to avoid global variables in general, but this is easier to mess up
when designing things in the module scope.
This commit is contained in:
Kyle Evans 2018-02-20 05:21:58 +00:00
parent 699578a6b8
commit bb4b11cf98

View File

@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd February 19, 2018
.Dd February 20, 2018
.Dt STYLE.LUA 9
.Os
.Sh NAME
@ -86,7 +86,7 @@ should be done explicitly, rather than as a boolean expression.
Single-line conditional statements and loops should be avoided.
.Pp
.Ic local
variables should be preferred to module scope variables.
variables should be preferred to global variables in module scope.
.Pp
Multiple local variables should not be declared
.Sy and