fix typo #320
fix typo #320
Conversation
AmirH-A
commented
Jun 10, 2024
AmirH-A
commented
- resolve typos inside [portal-wire-protocol.md] and [implementation-details-overlay.md]
portal-wire-protocol.md
Outdated
| @@ -124,11 +129,19 @@ selector = 0x03 | |||
| nodes = Container(total: uint8, enrs: List[ByteList[2048], max_length=32]) | |||
| ``` | |||
|
|
|||
| <<<<<<< HEAD | |||
There was a problem hiding this comment.
Looks like some merge conflict leftovers
| - `total`: The total number of `Nodes` response messages being sent. Currently fixed to only 1 response message. | ||
| - `enrs`: List of byte strings, each of which is an RLP encoded ENR record. | ||
| _ Individual ENR records **MUST** correspond to one of the requested distances. | ||
| _ It is invalid to return multiple ENR records for the same `node_id`. \* The ENR record of the requesting node **SHOULD** be filtered out of the list. |
There was a problem hiding this comment.
This unordered list went wrong.
And to add on that, all the unordered list changes are not needed in the first place as asterisks, pluses, and hyphens may all be used for this in markdown.
The same applies for the emphasis asterisks vs underscores.
| Upon *sending* this message, the requesting node **SHOULD** *listen* for an incoming uTP stream with the generated `connection_id`. | ||
| Upon _sending_ this message, the requesting node **SHOULD** _listen_ for an incoming uTP stream with the generated `connection_id`. | ||
|
|
||
| Upon *receiving* this message, the serving node **SHOULD** *initiate* a uTP stream with the received `connection_id`. | ||
| Upon _receiving_ this message, the serving node **SHOULD** _initiate_ a uTP stream with the received `connection_id`. |
There was a problem hiding this comment.
unneeded change as mentioned above.
| Upon *sending* this message with a `connection_id`, the sending node **SHOULD** *listen* for an incoming uTP stream with the generated `connection_id`. | ||
| Upon _sending_ this message with a `connection_id`, the sending node **SHOULD** _listen_ for an incoming uTP stream with the generated `connection_id`. | ||
|
|
||
| Upon *receiving* this message with a `connection_id`, the receiving node **SHOULD** *initiate* a uTP stream with the received `connection_id`. | ||
| Upon _receiving_ this message with a `connection_id`, the receiving node **SHOULD** _initiate_ a uTP stream with the received `connection_id`. |
There was a problem hiding this comment.
unneeded change as mentioned above.
There was a problem hiding this comment.
The _ and - changes are required by the ethereum/EIPs linter. We should review and merge Pipers PR before this one though @kdeme
There was a problem hiding this comment.
ok, fair enough. Same linter should be setup on this repo then also.
There was a problem hiding this comment.
Very good. I will be happy if I can help in this matter
