Translate comments into English #46
Conversation
| /// Height is determined by amount of values: `H = len / 2 +1` | ||
| /// H | Values | ||
| /// 0 | Value hashes | ||
| /// 1..| Hashes tree, where each height calculates Hash(Hash(h - 1, i), Hash(h - 1, i + 1)) |
There was a problem hiding this comment.
/// Merkle tree over list. Data in table is stored in rows.
/// Height is determined by amount of values: H = log2(values_length) + 1
/// 0 | Values, stored in the structure by index. A datum is stored at (0, index).
/// 1 | Hash of value datum, stored at level 0. (1, index) = Hash((0, index))
/// H > 1 | Merkle tree node, where at position (h, i) = Hash((h - 1, 2i) + (h - 1, 2i + 1)).
+ operation is concatenation of byte arrays.
There was a problem hiding this comment.
Do you test this comment with rustdoc? Maybe more suitable to use markdown lists or tables?
There was a problem hiding this comment.
I have tried to make a table, but without a header row it looks ugly. I suppose a list also does not fit here, because we have custom "list numbers" here instead of standard numbers/bullets. So I'm just going to add new lines in order to make this look a little better.
There was a problem hiding this comment.
Then maybe add a header row?
| Height | Stored data |
|---|---|
| 0 | Values stored in the structure by index |
| 1 | Hash of value datum stored at level 0: (1, index) = Hash((0, index)) |
| > 1 | Merkle tree node, where at position (h, i) = Hash((h - 1, 2i) + (h - 1, 2i + 1)) |
Raw:
| Height | Stored data |
|--------:|--------------|
| 0 | Values stored in the structure by index |
| 1 | Hash of value datum stored at level 0: `(1, index) = Hash((0, index))` |
| > 1 | Merkle tree node, where at position `(h, i) = Hash((h - 1, 2i) + (h - 1, 2i + 1))` |
exonum/src/messages/protocol.rs
Outdated
| @@ -24,7 +24,7 @@ pub const REQUEST_PREVOTES_MESSAGE_ID: u16 = 8; | |||
| pub const REQUEST_PEERS_MESSAGE_ID: u16 = 9; | |||
| pub const REQUEST_BLOCK_MESSAGE_ID: u16 = 10; | |||
|
|
|||
| // когда присоединяются узлы | |||
| // Node connection. | |||
There was a problem hiding this comment.
Methinks a period . is unnecessary for such short comments
exonum/src/messages/protocol.rs
Outdated
| @@ -37,7 +37,7 @@ message! { | |||
| } | |||
| } | |||
|
|
|||
| // консенсус | |||
| // Consensus. | |||
There was a problem hiding this comment.
Are these comments supposed to describe message types? They are not very informative.
There was a problem hiding this comment.
I suppose these comments mean only "this message is part of consensus" as opposed to other "service" messages such as Connect.
Anyway, I see no reason to have comments like "Peers request" at all:
// Peers request.
message! {
RequestPeers {There was a problem hiding this comment.
I had in mind something like
// Request connected peers from the node `to`.
//
// ### Processing
// * The message is authenticated by the pubkey `from`.
// It must be in the receiver's full node list
// * If the message is properly authorized, the node responds with...
//
// ### Generation
// A node generates `RequestPeers` under such and such conditions...
message! {
RequestPeers {Maybe, this is the wrong place to describe messages, but I feel that they should be described somewhere.
There was a problem hiding this comment.
It would be great to have such detailed (and meaningful) comments, although I'm solving one specific problem here. Currently we cannot format our code automatically because of comments in Russian. I suppose there should be a separate task for documenting our code.
There was a problem hiding this comment.
Agree, this is a subject of another PR. Can I open the corresponding issue?
There was a problem hiding this comment.
Sure, feel free to open any issues you think appropriate.
Enable testing and fix doc-test
Reorganize into library
remove bower
No description provided.