Language and style
We use the US English spelling.
We say «instance» rather than «server» to refer to a Tarantool
server instance. This keeps the manual terminology consistent with names like
/etc/tarantool/instances.enabled in the Tarantool environment.
Wrong usage: «Replication allows multiple Tarantool servers to work with copies of the same database.»
Correct usage: «Replication allows multiple Tarantool instances to work with copies of the same database.»
Say exactly one thing in a sentence. If you want to define or clarify something, do it in a separate sentence. Simple sentences are easier to read, understand and translate.
|Dogs (I have three of them) are my favourite animals. Their names are Ace, Bingo and Charm; Charm is the youngest one.||Dogs are my favourite animals. I have three of them. Their names are Ace, Bingo and Charm. Charm is the youngest one.|
|memtx (in-memory движок базы данных) используется по умолчанию, который был первым.||memtx is an in-memory storage engine. It is the default and was the first to arrive.|
|The replica set from where the bucket is being migrated is called the source; the target replica set where the bucket is being migrated to is called the destination.||The replica set from where the bucket is being migrated is called the source. The target replica set where the bucket is being migrated to is called the destination.|
Don’t use the following contractions:
- «i.e.»—from the Latin «id est». Use «that is» or «which means» instead.
- «e.g.»—from the Latin «exempli gratia». Use «for example» or «such as» instead.
Many people, especially non-native English speakers, aren’t familiar with the «i.e.» and «e.g.» contractions or don’t know the difference between them. For this reason, it’s best to avoid using them.