Naming convention for table parameters

We use this naming convention.

All lower case.
Prefer short single words if possible
Words separated by underscore characters _

Preferred	Instead of	Why

Preferred	Instead of	Why
key	password	Better to be consistent with the use of key If we can
organization	Organization	Small case
space	ConfluenceSpace	Space is shorter and has less redundant words in front of it.
user	username	This gives the same information and is shorter.

So imagine you read a book that was written in a combination of 5 languages. It might make for an intellectually curiosity, but it would greatly reduce the number of people who could understand.

With Iguana we want our platform to be easily accessible expressing the code using a consistent simple ‘language’ is important. It’s about reducing Bottlenecks for our users to understand how to use Iguana.

This makes for code which is briefer and easier to read. There is more space for:

Annotation Windows

Unfortunately this does mean we have to pick a language - we pick English since we are based in North America and this is the defacto global language and most of our customers pick English.

Lua itself uses English keywords. One has to pick a standard.

See Naming Convention.

See Using a table as a function argument

IguanaX Documentation

Naming convention for table parameters

Related pages