Skip to content

Commit c2bbb5c

Browse files
authored
Recommend writing in simple sentences (#1853)
1 parent 9f6532d commit c2bbb5c

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

doc/contributing/docs/style.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,44 @@ of the same databases."
2323
Correct usage: "Replication allows multiple Tarantool *instances* to work on
2424
copies of the same databases."
2525

26+
27+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28+
Express one idea in a sentence
29+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30+
31+
Say exactly one thing in a sentence.
32+
If you want to define or clarify something, do it in a separate sentence.
33+
Simple sentences are easier to read, understand and translate.
34+
35+
.. rst-class:: table-example
36+
.. container:: table
37+
38+
.. rst-class:: left-align-column-1
39+
.. rst-class:: left-align-column-2
40+
41+
.. list-table::
42+
:header-rows: 1
43+
44+
* - Don't
45+
- Do
46+
47+
* - Dogs (I have three of them) are my favourite animals.
48+
Their names are Ace, Bingo and Charm; Charm is the youngest one.
49+
50+
- Dogs are my favourite animals.
51+
I have three of them.
52+
Their names are Ace, Bingo and Charm.
53+
Charm is the youngest one.
54+
55+
* - memtx (the in-memory storage engine) is the default and was the first to arrive.
56+
- memtx is an in-memory storage engine.
57+
It is the default and was the first to arrive.
58+
59+
* - A replica set from which the bucket is being migrated is called a source;
60+
a target replica set to which the bucket is being migrated is called a destination.
61+
- A replica set from which the bucket is being migrated is called a source.
62+
A target replica set to which the bucket is being migrated is called a destination.
63+
2664
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2765
Don't use i.e. and e.g.
2866
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)