Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Expand
titleUsing a single consistent naming convention makes it easier for many customers to learn Iguana

So imagine you read a book that was written in a combination of 5 languages. It might make for an intellectually challenging read but would be difficult for most people to 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.

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.

Sorry cannot argue with history.

...

Expand
titleWhy favour shorter names

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

Annotation Windows

See Naming conventions.

See Using a table as a function argument

...