Top.Mail.Ru
Language and style | Tarantool
 

Language and style

Language and style

В английской версии документации мы придерживаемся американского варианта английского языка.

Ссылаясь на экземпляр Tarantool-сервера, мы говорим «экземпляр», а не «сервер». Это обеспечивает однородность терминологии в руководстве и именами в окружении Tarantool’а (например, /etc/tarantool/instances.enabled – активные экземпляры).

Неправильно: «С помощью репликации несколько серверов Tarantool’а могут работать на копиях одинаковых баз данных.»

Правильно: «С помощью репликации несколько экземпляров Tarantool’а могут работать на копиях одинаковых баз данных.»

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.

Don’t Do
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 (the in-memory storage engine) is the default and was the first to arrive. memtx is an in-memory storage engine. It is the default and was the first to arrive.
A replica set from which the bucket is being migrated is called a source; a target replica set to which the bucket is being migrated is called a destination. A replica set from which the bucket is being migrated is called a source. A target replica set to which the bucket is being migrated is called a destination.

Don’t use the following contractions:

  • «i.e.» —from Latin «id est». Use «that is» or «which means» instead.
  • «e.g.» —from Latin «exempli gratia». Use «for example» or «such as» instead.

Many people, especially non-native English speakers, aren’t familiar or don’t know the difference between «i.e.» and «e.g.» contractions. So it’s best to avoid using them.