Skip to content

Commit bde027d

Browse files
Apply suggestions from code review
Co-authored-by: Ekaterina Mekhnetsova <mekkatya@gmail.com> Signed-off-by: 0x009922 <a.marcius26@gmail.com>
1 parent df7415b commit bde027d

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

src/api/config/logger-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ TODO: which file extension should we use in examples? `.jsonlogs`?
8282
- **Type:** Boolean
8383
- **Default:** `false`
8484

85-
Uses compact logging format.
85+
Use compact logging format.
8686

8787
**Example:**
8888

src/api/config/queue-params.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Queue Parameters
22

3-
TODO Explain Queue module. That is holds or incoming transactions. From time to time, Sumeragi fetches them in order to
3+
TODO Explain Queue module. The queue holds incoming transactions. From time to time, Sumeragi fetches them in order to
44
create a block.
55

66
## `queue.max_transactions_in_queue`
@@ -54,7 +54,7 @@ transaction_time_to_live = "24h"
5454
- **Type:** String or Number, [Duration](glossary#type-duration)
5555
- **Default:** 1 second
5656

57-
The threshold to determine if a transaction has been tampered to have a future timestamp.
57+
The threshold to determine if a transaction has been tampered with to have a future timestamp.
5858

5959
TODO: explain that _timestamp_ is the value specified in
6060
[`TransactionPayload`'s `creation_time_ms` field](/api/data-model-schema#transactionpayload).

src/api/config/sumeragi-params.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ transactions and blocks, refer to consensus section and maybe some others.
99
- **Type:** String or Number, [Duration](glossary#type-duration)
1010
- **Default:** 2 seconds
1111

12-
Time since the round start[^1] by which a new block should be created regardless if there were enough transactions or
13-
not. Used to force block commits when there is a small influx of new transactions.
12+
Time since the start of the round[^1] by which a new block should be created regardless if there were enough transactions or
13+
not. This forces block commits when there is a small influx of new transactions.
1414

1515
A block might be created earlier if there is enough transactions in the [Queue](queue-params). The limit of transactions
1616
is configured by [`sumeragi.transactions_in_block`](#sumeragi-transactions-in-block).
@@ -38,7 +38,7 @@ block_gossip_period = "5s"
3838

3939
::: warning
4040

41-
More frequent gossiping shortens the time to sync, but can overload the network.
41+
More frequent gossiping shortens the time to sync but can overload the network.
4242

4343
:::
4444

@@ -65,7 +65,7 @@ commit_time = "4s"
6565
- **Type:** Number
6666
- **Default:** $4$
6767

68-
The amount of blocks that can be sent in a single synchronization message.
68+
The number of blocks that can be sent in a single synchronization message.
6969

7070
**Example:**
7171

@@ -79,7 +79,7 @@ max_blocks_per_gossip = 4
7979
- **Type:** Number
8080
- **Default:** $500$
8181

82-
Max number of transactions in a gossip batch message. Smaller size leads to longer time to synchronise, but useful if
82+
Max number of transactions in a gossip batch message. Smaller size leads to longer time to synchronise, but can be useful if
8383
you have high packet loss.
8484

8585
**Example:**
@@ -105,7 +105,7 @@ transaction_gossip_period = "1s"
105105

106106
::: warning
107107

108-
More frequent gossiping shortens the time to sync, but can overload the network.
108+
More frequent gossiping shortens the time to sync but can overload the network.
109109

110110
:::
111111

@@ -116,7 +116,7 @@ More frequent gossiping shortens the time to sync, but can overload the network.
116116

117117
The upper limit of the number of transactions per block. If there is enough transactions in the [Queue](queue-params),
118118
the block is created immediately. Otherwise, the block is created when [`sumeragi.block_time`](#sumeragi-block-time) is
119-
elapsed since the round start[^1].
119+
elapsed since the start of the round[^1].
120120

121121
**Example:**
122122

@@ -191,5 +191,5 @@ trusted_peers = [
191191
```
192192

193193
[^1]:
194-
The round start happens on peers rotation, when the leader is elected. Generally it happens after the previous block
194+
The start of the round happens when the leader is elected during peer rotation. Generally it happens after the previous block
195195
is committed. See [Consensus](/guide/blockchain/consensus) (todo: that page doesn't mention "round start" term ).

src/api/config/torii-params.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
TODO: Explain Torii module
44

5-
This module contains configuration of [Torii](/guide/glossary#torii) - the API gateway of Iroha. Refer to the [Torii Endpoints reference](/api/torii-endpoints) for information about exact endpoints.
5+
This module contains configuration of [Torii](/guide/glossary#torii), the API gateway of Iroha. Refer to the [Torii Endpoints reference](/api/torii-endpoints) for detailed information about endpoints.
66

77
## `torii.address`
88

99
- **ENV:** `API_ENDPOINT`
1010
- **Type:** String, [Socket-Address](glossary#type-socket-address)
1111
- **Required**
1212

13-
Address on which Torii Endpoints will be accessible.
13+
Address at which Torii Endpoints will be accessible.
1414

1515
```toml
1616
[torii]

0 commit comments

Comments
 (0)